Habilidades llm-doc-writer
📦

llm-doc-writer

v1.0.0 Seguro

Crear documentación para LLM eficiente en tokens

La documentación extensa desperdicia contexto y ralentiza el trabajo asistido por IA. Esta skill convierte el conocimiento del proyecto en tablas concisas, viñetas, ejemplos y una estructura lista para agentes.

Compatible con: Claude Codex Code(CC)
🥈 81 Plata
1

Descargar el ZIP de la habilidad

2

Subir en Claude

Ve a Configuración → Capacidades → Habilidades → Subir habilidad

3

Activa y empieza a usar

Recursos legibles por agentes

Usa estos enlaces cuando un agente de IA, crawler o script necesite contexto limpio en vez de leer la página completa.

Detalle Markdown GET /skills/aceek-llm-doc-writer.md Manifest firmado GET /api/skills/aceek-llm-doc-writer/manifest Lockfile firmado GET /api/skills/aceek-llm-doc-writer/lockfile

Pruébalo

Usando "llm-doc-writer". Un README largo con instrucciones de configuración, detalles del stack y prosa sobre arquitectura.

Resultado esperado:

Un README más corto con una tabla del stack, pasos de configuración numerados, referencia de comandos y viñetas de arquitectura.

Usando "llm-doc-writer". Un proyecto sin orientación para agentes para Claude, Codex o Claude Code.

Resultado esperado:

Una guía compacta para agentes con comandos, convenciones, notas de arquitectura y enlaces a archivos detallados.

Usando "llm-doc-writer". Una sección de API escrita como párrafos.

Resultado esperado:

Un resumen de endpoints fácil de escanear con campos obligatorios, respuestas esperadas y notas de uso concisas.

Auditoría de seguridad

Seguro
v7 • 6/28/2026

Static analysis reported external command, network, weak crypto, and reconnaissance patterns. Manual review found only markdown examples, inline code formatting, and ordinary documentation text, with no executable code or malicious intent.

2
Archivos escaneados
282
Líneas analizadas
4
Review items
0
False positives ignored

Confirmed security concerns (4)

Bajo
patterns.md:7patterns.md:23patterns.md:27patterns.md:41patterns.md:49patterns.md:58patterns.md:62patterns.md:65patterns.md:71patterns.md:72patterns.md:80patterns.md:89patterns.md:93patterns.md:97patterns.md:98patterns.md:99patterns.md:100patterns.md:108patterns.md:119patterns.md:123patterns.md:126patterns.md:134SKILL.md:20SKILL.md:30SKILL.md:36SKILL.md:48SKILL.md:52SKILL.md:61SKILL.md:62SKILL.md:63SKILL.md:67SKILL.md:73SKILL.md:75SKILL.md:76SKILL.md:82SKILL.md:93SKILL.md:94SKILL.md:95SKILL.md:103SKILL.md:109
False Positive: Markdown Backticks Misread as Shell Execution
The external command detections are markdown fences or inline command examples. No Ruby code, shell execution logic, or user-controlled command invocation was found.
Both scanned files are markdown documentation. The flagged locations are code fences, inline command examples, or formatting markers, not executable Ruby backtick calls.
Bajo
patterns.md:12patterns.md:19patterns.md:104SKILL.md:3SKILL.md:38SKILL.md:98
False Positive: Weak Crypto Pattern in Documentation Text
The weak cryptography detections match ordinary words and markdown references. No hashing, encryption, signing, or credential handling implementation was found.
Manual review found no cryptographic code. The lines contain documentation prose, headers, or references such as CLAUDE.md.
Bajo
patterns.md:117
False Positive: Network Pattern in Architecture Example
The network detection appears in a prose example about REST APIs between services. No Python HTTP library import, endpoint, or outbound request code was found.
The line is inside a before-and-after documentation example. It describes architecture communication and does not perform network activity.
Bajo
patterns.md:139
False Positive: Reconnaissance Pattern in Section Heading
The reconnaissance detection maps to an anti-patterns heading. No host, user, process, environment, or filesystem discovery command was found.
The flagged line is a markdown heading introducing writing anti-patterns. There is no executable system reconnaissance behavior in the file.
Auditado por: codex Ver historial de auditorías →

Puntuación de calidad

55
Arquitectura
100
Mantenibilidad
87
Contenido
70
Comunidad
97
Seguridad
91
Cumplimiento de la especificación

Lo que puedes crear

Preparar contexto para agentes

Crear un archivo CLAUDE.md conciso o un archivo de instrucciones para agentes para una base de código existente.

Comprimir documentación técnica

Reescribir secciones largas de configuración, arquitectura o API como documentación fácil de escanear.

Estandarizar README de proyectos

Crear secciones README consistentes para stack, comandos, convenciones y referencias.

Prueba estos prompts

Redactar un documento básico para agentes 
Crea un CLAUDE.md para este proyecto. Incluye stack, comandos, arquitectura, convenciones y enlaces a archivos de detalle.
Reescribir documentación extensa 
Reescribe esta documentación para contexto de LLM. Usa tablas, viñetas y ejemplos. Elimina relleno y afirmaciones redundantes.
Diseñar una división de documentación 
Revisa este documento largo del proyecto. Propón un documento principal para agentes más archivos enfocados para arquitectura, API y flujos de trabajo.
Auditar eficiencia de tokens 
Audita esta documentación en cuanto a eficiencia de tokens. Identifica secciones extensas, comandos faltantes, convenciones poco claras y contenido para dividir.

Mejores prácticas

  • Proporciona hechos de origen antes de pedir a la skill que escriba la documentación final.
  • Mantén breve el documento principal para agentes y enlaza a archivos de detalle enfocados.
  • Revisa los comandos generados y las notas de arquitectura comparándolos con el repositorio real.

Evitar

  • No uses la skill para inventar detalles faltantes del proyecto.
  • No mantengas párrafos narrativos largos cuando una tabla o lista sea más clara.
  • No coloques todos los detalles del proyecto en un único archivo de contexto para agentes.

Preguntas frecuentes

¿Qué tipo de documentación crea esta skill?
Crea documentación concisa para asistentes de IA, incluidos archivos CLAUDE.md, secciones README e instrucciones para agentes.
¿Puede mejorar un README existente?
Sí. Puede reescribir secciones extensas como tablas, viñetas, ejemplos y material de referencia más breve.
¿Ejecuta comandos del proyecto?
No. La skill proporciona orientación de redacción y ejemplos. No ejecuta comandos.
¿Es útil para Codex y Claude Code?
Sí. Se centra en el contexto que ayuda a Claude, Codex y Claude Code a entender rápidamente un repositorio.
¿Puede verificar la precisión técnica?
No. Los usuarios deben verificar los comandos generados, las notas de arquitectura y los detalles de API comparándolos con el proyecto.
¿Cuándo deben dividirse los documentos largos?
Divide los documentos cuando el archivo principal se vuelve difícil de escanear o supera el contexto esencial que necesita un asistente.

Detalles del desarrollador

Autor

Aceek

Licencia

MIT

Version

v1.0.0

Repositorio

https://github.com/Aceek/claude-config/tree/master/src/skills/llm-doc-writer

Ref.

master

Estructura de archivos

📄 patterns.md

📄 SKILL.md