Habilidades when-documenting-code-use-doc-generator

📦

when-documenting-code-use-doc-generator

Name: when-documenting-code-use-doc-generator
Author: DNYoussef

v1.0.0 Revisión del contenido r1 Riesgo alto ⚙️ Comandos externos🌐 Acceso a red📁 Acceso al sistema de archivos🔑 Variables de entorno

Generar documentación completa del código

Las bases de código a menudo carecen de referencias de API actualizadas, archivos README, comentarios y diagramas. Esta skill analiza la estructura del proyecto y produce recursos de documentación para flujos de trabajo de Claude, Codex y Claude Code.

Compatible con: Claude Codex Code(CC)

⚠️ 38 Deficiente

Detente y solicita confirmación antes de instalar.

Revisa el plan y obtén el consentimiento explícito del usuario antes de modificar archivos.

Instalar con mi Agente

Copia esta solicitud en tu Agente. Incluye la página canónica del Skill y el manifiesto.

Solicitud de agente

Review the Skillstore skill "when-documenting-code-use-doc-generator" from https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator.md and its manifest at https://skillstore.io/api/skills/dnyoussef-when-documenting-code-use-doc-generator/manifest. Verify the artifact. Stop and obtain explicit user consent before installing or changing files.

Tu Agente debe seguir mostrando su plan y solicitar cualquier confirmación exigida por la política de seguridad.

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/dnyoussef-when-documenting-code-use-doc-generator.md Manifest firmado GET /api/skills/dnyoussef-when-documenting-code-use-doc-generator/manifest Lockfile firmado GET /api/skills/dnyoussef-when-documenting-code-use-doc-generator/lockfile

Pruébalo

Usando "when-documenting-code-use-doc-generator". Un proyecto de API Node.js tiene rutas pero no referencia de API.

Resultado esperado:

La skill produce una descripción general de la API con resúmenes de endpoints, notas de autenticación, descripciones de respuesta y enlaces a archivos de documentación generados.

Usando "when-documenting-code-use-doc-generator". Un repositorio tiene un README desactualizado y faltan instrucciones de configuración inicial.

Resultado esperado:

La skill redacta un README actualizado con secciones de descripción general del proyecto, requisitos previos, instalación, uso, pruebas, configuración y contribución.

Usando "when-documenting-code-use-doc-generator". Una carpeta de código fuente contiene funciones públicas sin comentarios.

Resultado esperado:

La skill informa sobre la cobertura de documentación y propone comentarios en línea para las funciones que necesitan descripciones de parámetros y valores de retorno.

Auditoría de seguridad

Riesgo alto

v9 • 5/7/2026 Abrir el informe versionado

Most static findings are false positives from Markdown examples, generated documentation placeholders, or sample configuration names. The executable slash-command scripts are real shell entry points, and the larger concern is their unpinned npx execution of claude-flow plus default writes to repository documentation files.

Archivos escaneados

3,881

Líneas analizadas

Elementos de revisión

Falsos positivos ignorados

Preocupaciones de seguridad confirmadas (2)

Alto

slash-command-doc-api.sh:100-103 slash-command-doc-inline.sh:98-102 slash-command-doc-readme.sh:87-91

Unpinned Third-Party Package Execution

The slash-command scripts invoke npx claude-flow@alpha for hooks and memory storage. Running an alpha npm package during documentation generation can download and execute third-party code.

The scripts directly call npx with an external package name in executable paths. This is a clear supply-chain execution risk even though it appears intended for workflow coordination.

Medio

slash-command-doc-readme.sh:93-99 slash-command-doc-readme.sh:167-178 slash-command-doc-api.sh:94-96 slash-command-doc-api.sh:231-233

Documentation Scripts Modify Repository Files by Default

The README and API scripts create or overwrite documentation files in the current project. This can change repository contents without a dry-run default or confirmation prompt.

The cited script paths create directories, copy generated specs, back up README.md, and write README content. These are intended actions but still affect repository state by default.

Elementos de revisión de capacidades (3)

Estas son capacidades locales reales que pueden esperarse para esta habilidad, por lo que requieren revisión, pero no se cuentan como comportamiento malicioso confirmado.

Medio

slash-command-doc-api.sh:1

Unix shell invocation

#!/bin/bash

This is an executable Bash entry point that scans project files and writes documentation outputs. Shell automation is expected, but it is still real command-execution behavior for a marketplace skill.

Medio

slash-command-doc-inline.sh:1

Unix shell invocation

#!/bin/bash

Medio

slash-command-doc-readme.sh:1

Unix shell invocation

#!/bin/bash

Factores de riesgo

⚙️ Comandos externos (180)

🌐 Acceso a red (34)

📁 Acceso al sistema de archivos (45)

🔑 Variables de entorno (5)

PROCESS.md:734 SKILL.md:491 SKILL.md:408 SKILL.md:409 slash-command-doc-readme.sh:465

Auditado por: codex Ver historial de auditorías →

Compartir y citar este informe

Comparte el informe de evaluación versionado, la insignia neutral, la tarjeta insertable y las citas. Skillstore presenta evidencias sin decidir si este Skill es seguro.

Abrir el informe versionado

Copiar enlace del informe

https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Insignia Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/dnyoussef-when-documenting-code-use-doc-generator/security.svg)](https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator?utm_source=security_passport_badge)

Insignia HTML

<a href="https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/dnyoussef-when-documenting-code-use-doc-generator/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Tarjeta para insertar

<iframe src="https://skillstore.io/embed/skills/dnyoussef-when-documenting-code-use-doc-generator.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>

Citas académicas (APA · BibTeX · CFF)

Cita APA

DNYoussef. (2026). when-documenting-code-use-doc-generator security audit report (audit version 9) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9

Cita BibTeX

@techreport{dnyoussef-dnyoussef-when-documenting-code-use-doc-generator-2026,
  author = {DNYoussef},
  title = {when-documenting-code-use-doc-generator security audit report (audit version 9)},
  institution = {Skillstore},
  year = {2026},
  number = {9},
  url = {https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9},
  note = {Author version 1.0.0}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "when-documenting-code-use-doc-generator security audit report (audit version 9)"
version: "1.0.0"
type: report
authors:
  - name: "DNYoussef"
date-released: "2026-07-05"
url: "https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9"
identifiers:
  - type: other
    value: "skillstore:dnyoussef-when-documenting-code-use-doc-generator:audit:9"
    description: "Skillstore immutable audit report identifier"

Puntuación de Skillstore

Por qué esta puntuación Confianza de la evidencia: Medio

Arquitectura

100

Mantenibilidad

Contenido

Comunidad

Cumplimiento de la especificación

Lo que puedes crear

Documentar una API de backend

Generar referencias de estilo OpenAPI, resúmenes de endpoints, notas de autenticación y ejemplos de uso para un repositorio de servicio.

Actualizar la documentación de incorporación del proyecto

Crear un README con secciones de configuración inicial, configuración, pruebas, contribución y soporte a partir de los metadatos del repositorio.

Mejorar la cobertura de comentarios del código

Identificar funciones sin documentar y crear orientación de comentarios en línea para los estilos de lenguaje compatibles.

Prueba estos prompts

Generar documentación básica

Usa esta skill para revisar el repositorio actual y generar documentación básica de README y API. Mantén la salida concisa y enumera los archivos modificados.

Crear referencia de API

Usa esta skill para documentar la REST API en este proyecto. Incluye endpoints, formatos de solicitud, resúmenes de respuesta, notas de autenticación y advertencias de validación.

Añadir comentarios en línea

Usa esta skill para encontrar funciones públicas sin documentar en src. Añade o propone JSDoc, TSDoc o docstrings de Python, y evita cambiar la lógica de negocio.

Crear un conjunto completo de documentación

Usa esta skill para generar README, referencia de API, notas de arquitectura, recomendaciones de comentarios en línea y un informe de brechas de documentación. Ejecútala en modo dry-run cuando sea posible y señala escrituras riesgosas antes de editar.

Mejores prácticas

Ejecuta la skill en una rama limpia y revisa los archivos generados antes de fusionar.
Proporciona el tipo de documentación objetivo, el formato preferido y el objetivo de cobertura.
Mantén los secretos fuera de los ejemplos y reemplaza los placeholders antes de publicar.

Evitar

No ejecutes scripts de generación en repositorios con cambios críticos sin confirmar.
No publiques detalles de API generados antes de comprobar la autenticación y la exposición de datos.
No asumas que los ejemplos están listos para producción sin validación.