Habilidades repo-docs
📦

repo-docs

Riesgo bajo ⚡ Contiene scripts📁 Acceso al sistema de archivos⚙️ Comandos externos

Generar documentación del repositorio

La documentación de repositorios a menudo omite pasos de configuración, contexto de arquitectura y dependencias entre servicios. Esta skill analiza una base de código y produce documentación estructurada para README, API, arquitectura, contribución e integraciones.

Soporta: Claude Codex Code(CC)
🥈 80 Plata
1

Descargar el ZIP de la skill

2

Subir en Claude

Ve a Configuración → Capacidades → Skills → Subir skill

3

Activa y empieza a usar

Recursos legibles por agentes

Usa estos enlaces cuando un AI Agent, crawler o script necesite contexto limpio en lugar de leer toda la página.

Detalle Markdown GET /skills/astrabit-cpt-repo-docs.md Manifest firmado GET /api/skills/astrabit-cpt-repo-docs/manifest Lockfile firmado GET /api/skills/astrabit-cpt-repo-docs/lockfile

Pruébalo

Usando "repo-docs". Genera documentación para un nuevo repositorio de servicio.

Resultado esperado:

Un esquema de README con pasos de inicio rápido, repositorios relacionados, notas de uso, enlaces de API, enlaces de arquitectura, flujo de trabajo de desarrollo y sección de licencia.

Usando "repo-docs". Documenta cómo este servicio se conecta con el resto de la plataforma.

Resultado esperado:

Un documento de integraciones que enumera servicios upstream, consumidores downstream, repositorios hermanos, servicios externos, protocolos y prácticas de actualización de dependencias.

Usando "repo-docs". Actualiza documentación obsoleta para colaboradores.

Resultado esperado:

Una guía de contribución revisada con requisitos previos, orden de clonación, configuración del entorno, comandos de prueba, estructura del proyecto, proceso de pull request y canales de soporte.

Auditoría de seguridad

Riesgo bajo
v6 • 6/28/2026

Static analysis reported many high and critical alerts, but review found they are mostly markdown templates, grep examples, and regex strings rather than active malicious behavior. The package includes Python helper scripts that recursively read local repository files for documentation analysis, so users should run it only on repositories they intend to document. No prompt injection attempt, credential exfiltration, unauthorized network request, or destructive action was found.

10
Archivos escaneados
1,533
Líneas analizadas
6
hallazgos
6
Auditorías totales
Problemas de riesgo bajo (3)
scripts/analyze-repo-structure.py:152-155scripts/find-integration-points.py:149-160
Local Repository Files Are Read Recursively
The helper scripts accept a repository path and scan files under that path to detect technologies and integration references. This is intended for documentation, but it may expose private file names or import strings in generated output if run on sensitive repositories.
SKILL.md:194-197examples/README-template.md:7-20examples/CONTRIBUTING-template.md:17-34references/tech-detection.md:146-169
Static Command Alerts Are Documentation Examples
Many command-execution findings refer to markdown command blocks, placeholder install commands, grep examples, or the skill instruction to run its helper script. These are not dynamic shell execution in code, but users should review commands before copying them into project docs.
examples/README-template.md:12examples/CONTRIBUTING-template.md:19-22references/tech-detection.md:118-161references/integration-patterns.md:66-72
Static Network And Path Alerts Are False Positives
Network alerts are placeholder clone URLs, HTTP client names, and detection regexes. The path traversal alert is an example of an incorrect relative import in documentation, not filesystem traversal logic.

Factores de riesgo

⚡ Contiene scripts (3)
scripts/analyze-repo-structure.py:233-248 scripts/find-integration-points.py:225-249 SKILL.md:189-197
📁 Acceso al sistema de archivos (4)
scripts/analyze-repo-structure.py:152-155 scripts/analyze-repo-structure.py:239-245 scripts/find-integration-points.py:149-160 scripts/find-integration-points.py:236-243
⚙️ Comandos externos (4)
SKILL.md:194-197 examples/README-template.md:7-20 examples/CONTRIBUTING-template.md:17-34 references/tech-detection.md:146-169
Auditado por: codex Ver historial de auditorías →

Puntuación de calidad

64
Arquitectura
100
Mantenibilidad
87
Contenido
70
Comunidad
84
Seguridad
83
Cumplimiento de la especificación

Lo que puedes crear

Crear documentación de incorporación

Genera un README claro y una guía CONTRIBUTING para ingenieros que se incorporan a un proyecto existente.

Mapear dependencias de servicios

Identifica servicios upstream, consumidores downstream, paquetes compartidos y protocolos de comunicación entre repositorios.

Actualizar documentación obsoleta del proyecto

Compara la estructura actual del código con la documentación existente y actualiza los detalles faltantes de configuración, arquitectura y API.

Prueba estos prompts

Generar un README 
Genera un README para este repositorio. Incluye configuración, uso, estructura del proyecto, repositorios relacionados y enlaces a documentación más detallada.
Crear documentación para colaboradores 
Crea una guía CONTRIBUTING para este repo. Incluye requisitos previos, configuración local, pruebas, estilo de código, pasos para pull request y repositorios relacionados.
Documentar arquitectura e integraciones 
Analiza este repositorio y escribe ARCHITECTURE.md e INTEGRATIONS.md. Enfócate en componentes, flujo de datos, dependencias upstream, consumidores downstream y servicios externos.
Auditar y actualizar documentación existente 
Revisa la documentación existente frente a la base de código actual. Identifica secciones obsoletas, puntos de integración faltantes y brechas de configuración, luego actualiza la documentación con cambios concisos.

Mejores prácticas

  • Ejecuta el análisis en un checkout local limpio para que la documentación generada refleje el estado actual del repositorio.
  • Revisa los puntos de integración detectados con los propietarios de los servicios antes de publicar afirmaciones sobre dependencias o propiedad.
  • Mantén los ejemplos generados breves, verificados y vinculados a comandos o archivos fuente reales del repositorio.

Evitar

  • No publiques documentación generada sin comprobar los comandos de configuración, enlaces y nombres de servicios.
  • No ejecutes los scripts auxiliares en repositorios que contengan datos sensibles fuera del alcance de la documentación.
  • No trates las integraciones detectadas por regex como dependencias confirmadas sin validación humana.

Preguntas frecuentes

¿Qué documentos puede crear esta skill?
Puede crear documentación de README, API, arquitectura, contribución e integraciones usando las plantillas incluidas.
¿Entiende las relaciones entre repositorios?
Busca paquetes internos, clientes de servicios, módulos compartidos y repositorios relacionados, y luego documenta relaciones probables.
¿Modifica código?
La skill se enfoca en la documentación. Puede editar archivos markdown cuando se le pide crear o actualizar documentación.
¿Envía datos del repositorio a servicios externos?
No se encontró evidencia de exfiltración a redes externas. Los scripts incluidos leen archivos locales e imprimen resúmenes locales.
¿Puede reemplazar a un redactor técnico humano?
No. Redacta documentación estructurada, pero los mantenedores deben verificar la precisión, la propiedad y los detalles de seguridad.
¿Qué herramientas de IA admite?
El informe enumera compatibilidad con Claude, Codex y Claude Code.

Detalles del desarrollador

Licencia

MIT

Repositorio

https://github.com/AstraBit-CPT/astrabit-docs/tree/master/.claude/skills/repo-docs

Ref.

master

Estructura de archivos

📁 examples/

📄 API-template.md

📄 ARCHITECTURE-template.md

📄 CONTRIBUTING-template.md

📄 INTEGRATIONS-template.md

📄 README-template.md

📁 references/

📄 integration-patterns.md

📄 tech-detection.md

📁 scripts/

📄 analyze-repo-structure.py

📄 find-integration-points.py

📄 SKILL.md