docs-agent
Update project documentation automatically
Documentation drift causes confusion and wasted time. This skill uses AI to automatically sync README files, API docs, and internal documentation with codebase changes. Keep your project docs accurate without manual effort.
Baixar o ZIP da skill
Upload no Claude
Vá em Configurações → Capacidades → Skills → Upload skill
Ative e comece a usar
Testar
A utilizar "docs-agent". Update README.md to reflect the new bulk contact update API endpoint
Resultado esperado:
- Added new feature section for bulk contact updates
- Updated API Documentation link to new endpoint
- Verified all code examples are current
- No broken internal links detected
A utilizar "docs-agent". Document the new POST /api/agents/analyze endpoint
Resultado esperado:
- Created endpoint documentation with request and response schemas
- Added TypeScript code example for calling the endpoint
- Listed all error codes and their meanings
- Updated table of contents with new section
A utilizar "docs-agent". Generate changelog for version 1.2.0
Resultado esperado:
- Created changelog with Added, Changed, Fixed, and Security sections
- Documented 5 new features, 3 improvements, and 2 bug fixes
- Formatted dates and version numbers correctly
- Preserved existing changelog entries
Auditoria de Segurança
SeguroThis is a pure documentation skill containing only markdown instructional content. All 122 static findings are FALSE POSITIVES caused by the scanner detecting patterns within documentation examples rather than executable code. The skill contains no executable code, no network operations, no file system access beyond reading/writing documentation files within the project directory.
Fatores de risco
🌐 Acesso à rede (2)
📁 Acesso ao sistema de arquivos (1)
⚙️ Comandos externos (97)
Pontuação de qualidade
O Que Você Pode Construir
Sync docs with code changes
Keep README and API docs accurate after each feature release
Maintain internal documentation
Update agent definitions and architecture docs systematically
Generate changelog entries
Automatically create release notes from code changes
Tente Estes Prompts
Update README.md to reflect the new feature: [describe feature]
Document the new API endpoint at [path] including method, request body, response format, and error codes
Generate a changelog entry for version [version] based on these changes: [list changes]
Review all markdown documentation files and update them to reflect the current state of the codebase
Melhores Práticas
- Update docs immediately after code changes to prevent drift
- Include code examples in all documentation updates
- Verify documentation changes against source code before saving
Evitar
- Batching multiple unrelated changes into one update
- Using casual or informal tone in technical documentation
- Skipping verification of code examples before publishing