Habilidades code-documentation-doc-generate

📦

code-documentation-doc-generate

Name: code-documentation-doc-generate
Author: sickn33

Revisão do conteúdo r1 Seguro ⚙️ Comandos externos🌐 Acesso à rede📁 Acesso ao sistema de arquivos🔑 Variáveis de ambiente

Gerar Documentação de Código a Partir de Repositórios

As bases de código frequentemente não têm documentação atualizada de API, arquitetura e usuário. Esta habilidade orienta Claude, Codex e Claude Code a extrair fatos dos arquivos-fonte e produzir documentação sustentável.

Suporta: Claude Codex Code(CC)

🥉 79 Bronze

Instalar com meu Agente

Copie esta solicitação para o seu Agente. Ela inclui a página canônica do Skill e o manifesto.

Solicitação do agente

Review the Skillstore skill "code-documentation-doc-generate" from https://skillstore.io/skills/sickn33-code-documentation-doc-generate.md and its manifest at https://skillstore.io/api/skills/sickn33-code-documentation-doc-generate/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

Seu Agente ainda deve apresentar o plano e solicitar qualquer confirmação exigida pela política de segurança.

Recursos legíveis por agentes

Use estes links quando um agente de IA, crawler ou script precisar de contexto limpo em vez de ler a página completa.

Detalhe em Markdown GET /skills/sickn33-code-documentation-doc-generate.md manifest assinado GET /api/skills/sickn33-code-documentation-doc-generate/manifest lockfile assinado GET /api/skills/sickn33-code-documentation-doc-generate/lockfile

Testar

Usando "code-documentation-doc-generate". Um serviço FastAPI com rotas de usuário e autenticação precisa de documentação publicável.

Resultado esperado:

Um plano de documentação de API, esboço de referência de endpoints, notas de autenticação, seção de respostas de erro e checklist de revisão.

Usando "code-documentation-doc-generate". Um repositório tem vários serviços e nenhuma visão geral da arquitetura.

Resultado esperado:

Um mapa de componentes, explicação do fluxo de dados, lista de dependências, descrição de diagrama Mermaid e orientação de manutenção.

Usando "code-documentation-doc-generate". Uma equipe de produto precisa de material de onboarding para uma nova funcionalidade.

Resultado esperado:

Um guia de primeiros passos, etapas de fluxos de trabalho comuns, tabela de solução de problemas, lista de premissas e perguntas de acompanhamento.

Auditoria de segurança

Seguro

v4 • 06/07/2026 Abrir o relatório versionado

All static findings are false positives from Markdown templates and illustrative code samples, not executable skill behavior. The skill asks assistants to analyze project source files for documentation, and I found no prompt injection, covert exfiltration, or hidden authority claims.

Arquivos analisados

690

Linhas analisadas

Itens de revisão

Falsos positivos ignorados

Fatores de risco

⚙️ Comandos externos (9)

resources/implementation-playbook.md:253-254 resources/implementation-playbook.md:254-255 resources/implementation-playbook.md:255-256 resources/implementation-playbook.md:256-259 resources/implementation-playbook.md:355-356 resources/implementation-playbook.md:356-357 resources/implementation-playbook.md:357-363 SKILL.md:34 SKILL.md:48

🌐 Acesso à rede (8)

resources/implementation-playbook.md:509 resources/implementation-playbook.md:503 resources/implementation-playbook.md:138 resources/implementation-playbook.md:469 resources/implementation-playbook.md:474 resources/implementation-playbook.md:500 resources/implementation-playbook.md:509 resources/implementation-playbook.md:520

📁 Acesso ao sistema de arquivos (1)

resources/implementation-playbook.md:589

🔑 Variáveis de ambiente (7)

resources/implementation-playbook.md:568 resources/implementation-playbook.md:319 resources/implementation-playbook.md:320 resources/implementation-playbook.md:321 resources/implementation-playbook.md:501 resources/implementation-playbook.md:511 resources/implementation-playbook.md:521

A auditoria estática e semântica concluída mais recente não detectou achados de segurança confirmados. Isso não comprova que a skill não tenha efeitos colaterais.

Auditado por: codex Ver histórico de auditoria →

Compartilhar e citar este relatório

Compartilhe o relatório de avaliação versionado, o badge neutro, o cartão incorporável e as citações. A Skillstore apresenta evidências sem decidir se este Skill é seguro.

Abrir o relatório versionado

Copiar link do relatório

https://skillstore.io/skills/sickn33-code-documentation-doc-generate/audits/4?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Badge Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/sickn33-code-documentation-doc-generate/security.svg)](https://skillstore.io/skills/sickn33-code-documentation-doc-generate?utm_source=security_passport_badge)

Badge HTML

<a href="https://skillstore.io/skills/sickn33-code-documentation-doc-generate?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-code-documentation-doc-generate/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Cartão incorporável

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

Citações acadêmicas (APA · BibTeX · CFF)

Citação APA

sickn33. (2026). code-documentation-doc-generate security audit report (audit version 4) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-code-documentation-doc-generate/audits/4

Citação BibTeX

@techreport{sickn33-sickn33-code-documentation-doc-generate-2026,
  author = {sickn33},
  title = {code-documentation-doc-generate security audit report (audit version 4)},
  institution = {Skillstore},
  year = {2026},
  number = {4},
  url = {https://skillstore.io/skills/sickn33-code-documentation-doc-generate/audits/4},
  note = {Author version unspecified}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "code-documentation-doc-generate security audit report (audit version 4)"
version: "unspecified"
type: report
authors:
  - name: "sickn33"
date-released: "2026-07-06"
url: "https://skillstore.io/skills/sickn33-code-documentation-doc-generate/audits/4"
identifiers:
  - type: other
    value: "skillstore:sickn33-code-documentation-doc-generate:audit:4"
    description: "Skillstore immutable audit report identifier"

Pontuação do Skillstore

Por que esta pontuação Confiança das evidências: Alto

Arquitetura

Manutenibilidade

Conteúdo

Comunidade

Conformidade com a especificação

O que você pode criar

Documentar um Novo Serviço de API

Criar referências de endpoints, esquemas, notas de autenticação e exemplos a partir da base de código de um serviço.

Padronizar a Documentação do Repositório

Produzir documentação de README, arquitetura, configuração e contribuição com terminologia e estrutura compartilhadas.

Criar Guias Voltados para Usuários

Transformar fluxos de produto e comportamento do código-fonte em tutoriais, guias de tarefas e material de solução de problemas.

Teste estes prompts

Criar um Plano de Documentação

Revise este repositório e proponha um plano de documentação. Inclua públicos-alvo, tipos de documentos, arquivos-fonte a inspecionar, lacunas e etapas de revisão.

Gerar Rascunhos de Referência de API

Analise as rotas de API, os esquemas e o fluxo de autenticação. Rascunhe uma referência de API com endpoints, parâmetros, respostas, erros e solicitações de exemplo seguras.

Criar Documentação de Arquitetura e Guias de Usuário

Crie documentação de arquitetura e guias de usuário a partir desta base de código. Inclua diagramas, responsabilidades dos componentes, fluxos de trabalho, premissas e notas de validação.

Projetar Automação de Documentação

Projete um fluxo de automação de documentação para este repositório. Inclua etapas de geração, linting, verificações de cobertura, gatilhos de CI, opções de implantação e pontos de revisão de segurança.

Boas práticas

Confirme os públicos-alvo e os tipos de documentos antes de gerar artefatos.
Use arquivos-fonte e configuração como a fonte de verdade.
Revise a documentação gerada quanto a segredos, hosts privados e premissas desatualizadas.

Evitar

Publicar documentação gerada sem validar exemplos contra o código atual.
Documentar segredos, URLs internas ou tokens de acesso de arquivos de configuração.
Usar um README genérico quando públicos diferentes precisam de estruturas diferentes.

Perguntas frequentes

Que documentação esta habilidade pode gerar?

Ela oferece suporte a documentação de API, documentação de arquitetura, referência de código, conteúdo de README, guias de usuário e planos de automação.

Ela precisa de acesso à base de código?

Sim. Ela funciona melhor quando arquivos-fonte, configuração, comentários e requisitos estão disponíveis.

Ela pode criar documentação OpenAPI?

Sim. Ela pode rascunhar estrutura OpenAPI, descrições de endpoints, esquemas, notas de autenticação e solicitações de exemplo.

Ela pode adicionar automação de documentação?

Sim. Ela pode propor etapas de CI, linting, verificações de cobertura e fluxos de implantação para documentação.

Como a documentação gerada deve ser revisada?

Verifique cada exemplo em relação ao código atual e remova segredos, hosts privados e afirmações sem suporte.

Isso é útil para projetos que não são APIs?

Sim. Ela pode produzir visões gerais de arquitetura, guias para desenvolvedores, guias de usuário e material de referência de código.

Detalhes do desenvolvedor

Autor

sickn33

Licença

MIT

Revisão da Skillstore

Aviso de versão

O autor não declarou uma versão.

Repositório

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/code-documentation-doc-generate

Referência

01171b582d636c013315c5e0d969c64f8d9cdff2

Atualidade da manutenção

22/07/2026

Uso

9 downloads · 109 visualizações

Estrutura de arquivos

📁 resources/

📄 implementation-playbook.md

📄 SKILL.md