Gerar Documentação Python
Projetos Python frequentemente não têm documentação de API atualizada. Esta habilidade ajuda Claude, Codex ou Claude Code a criar documentação em Markdown a partir da estrutura do código-fonte, docstrings e anotações de tipo.
Copie esta solicitação para o seu Agente. Ela inclui a página canônica do Skill e o manifesto.
Review the Skillstore skill "doc-generator" from https://skillstore.io/skills/bossjones-doc-generator.md and its manifest at https://skillstore.io/api/skills/bossjones-doc-generator/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.
Use estes links quando um agente de IA, crawler ou script precisar de contexto limpo em vez de ler a página completa.
Usando "doc-generator". Um usuário aponta a habilidade para um módulo Python com classes públicas, métodos e docstrings.
Resultado esperado:
Uma referência de API em Markdown com um resumo do módulo, seções de classes, assinaturas de métodos, notas de parâmetros, descrições de retorno e notas de uso.
Usando "doc-generator". Um usuário solicita conteúdo de README a partir de um pequeno pacote Python.
Resultado esperado:
Uma seção pronta para README com visão geral do pacote, resumo da API pública, orientação de uso comum e avisos sobre descrições ausentes.
Usando "doc-generator". Um usuário solicita cobertura de documentação para uma branch de release.
Resultado esperado:
Um relatório de documentação que lista seções geradas, docstrings ausentes, detalhes de parâmetros incompletos e correções sugeridas.
All eight static findings are false positives caused by Markdown fences or inline code formatting in SKILL.md. The skill contains no shell commands, prompt injection, network instructions, or semantic evidence of malicious intent.
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.
https://skillstore.io/skills/bossjones-doc-generator/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report[](https://skillstore.io/skills/bossjones-doc-generator?utm_source=security_passport_badge)<a href="https://skillstore.io/skills/bossjones-doc-generator?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/bossjones-doc-generator/security.svg" alt="Skillstore security assessment" loading="lazy"></a><iframe src="https://skillstore.io/embed/skills/bossjones-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>bossjones. (2026). doc-generator security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/bossjones-doc-generator/audits/9@techreport{bossjones-bossjones-doc-generator-2026,
author = {bossjones},
title = {doc-generator security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/bossjones-doc-generator/audits/9},
note = {Author version unspecified}
}cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "doc-generator security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
- name: "bossjones"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/bossjones-doc-generator/audits/9"
identifiers:
- type: other
value: "skillstore:bossjones-doc-generator:audit:9"
description: "Skillstore immutable audit report identifier"
Crie uma referência de API estruturada em Markdown a partir de módulos, classes, métodos e funções do pacote.
Gere seções de README que resumem APIs públicas, exemplos de uso e assinaturas de tipo disponíveis.
Transforme módulos de serviço ou utilitários em documentação legível para transferência de conhecimento, onboarding ou revisão.
Gere documentação em Markdown para este arquivo Python. Inclua o resumo do módulo, classes públicas, funções públicas, parâmetros, valores de retorno e avisos claros para docstrings ausentes.
Gere documentação de API para este pacote Python. Processe módulos públicos, agrupe a saída por módulo, inclua assinaturas de classes e funções e adicione um sumário.
Atualize a documentação Markdown existente usando o código-fonte Python atual. Preserve a estrutura atual quando possível, atualize assinaturas desatualizadas e indique membros públicos não documentados.
Revise esta base de código Python quanto à cobertura de documentação. Gere documentação de API em Markdown, identifique docstrings ausentes ou fracas e recomende as correções de documentação de maior prioridade.
Autor
bossjonesLicença
MIT
Revisão da Skillstore
r2
Aviso de versão
O autor não declarou uma versão.
Referência
a39a91716eadede5f4cdefd78178fed4e837a128
Atualidade da manutenção
25/07/2026
Uso
9 downloads · 173 visualizações
Estrutura de arquivos
📄 SKILL.md
Grave testes HTTP com pytest-recording
Testes HTTP frequentemente falham quando APIs ativas mudam ou credenciais vazam. Esta skill ajuda a configurar cassetes do pytest-recording e a sanitizar requisições gravadas.
Criar Modelos de Validação Pydantic v2
Os contratos de dados em Python podem divergir quando as entradas vêm de APIs, ficheiros ou utilizadores. Esta skill oferece padrões concisos de Pydantic v2 para validação, serialização e tratamento de erros.
Escreva Testes Pytest Melhores
Equipes Python precisam de testes confiáveis que permaneçam claros e fáceis de estender. Esta skill orienta Claude, Codex e Claude Code em fixtures do pytest, parametrização, testes assíncronos, mocking e organização de testes.
Executar apps Python ASGI com Uvicorn
Serviços Python assíncronos precisam de configurações claras de servidor para desenvolvimento e implantação. Esta skill fornece comandos concisos do Uvicorn, orientação de configuração e etapas de solução de problemas.
Adicionar Logging Estruturado a Aplicações Python
Serviços Python muitas vezes produzem logs de texto simples que são difíceis de pesquisar e correlacionar. Esta skill ajuda a configurar structlog para logs JSON estruturados, vinculação de contexto, testes e processadores adequados para produção.
Gerenciar Migrações de Banco de Dados com Alembic
Alterações no esquema do banco de dados são arriscadas quando as equipes não têm padrões de migração repetíveis. Esta skill oferece a Claude, Codex e Claude Code orientações práticas sobre Alembic para projetos SQLAlchemy.
Gerar documentação de lançamento bilíngue do GitHub
por ZhanlinCui
Criar documentação de lançamento polida leva tempo e requer consistência entre idiomas. Esta habilidade automatiza a geração de README bilíngue a partir dos metadados existentes do seu repositório.
Formatar Artigos em Markdown
por jimliu
Rascunhos muitas vezes não têm estrutura consistente, frontmatter e tipografia legível. Esta skill transforma texto simples ou Markdown bruto em Markdown organizado, pronto para revisão.
Arquitetura de Documentação de Repositórios
por AstraBit-CPT
A documentação de repositórios muitas vezes fica desatualizada quando dependências, APIs e etapas de configuração mudam. Esta skill analisa a estrutura e as integrações e, em seguida, ajuda a criar documentação de README, API, arquitetura, contribuição e integração.
Crie Estruturas de Repositório Awesome
por zjsxply
Criar uma lista awesome bem-acabada exige estrutura cuidadosa, regras de contribuição e etapas de verificação. Esta skill gera uma estrutura de repositório focada a partir de um tópico e recursos iniciais.
Write Clear Go Documentation
por samber
Go projects often have incomplete comments, examples, and contributor guidance that slow adoption and maintenance. This skill provides structured guidance for writing, reviewing, and organizing documentation that matches Go conventions.
Track Long Tasks With a Portable State Ledger
por glenskii
Long technical tasks lose decisions, evidence, and next actions across sessions. This skill maintains a concise Markdown state file with reviewed local evidence references.