docs-agent
自动更新项目文档
文档漂移会导致混淆和浪费时间。此技能使用AI自动将README文件、API文档和内部文档与代码库变更同步。无需手动操作即可保持项目文档的准确性。
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:
- 添加了批量联系人更新的新功能部分
- 将API文档链接更新到新端点
- 验证了所有代码示例都是最新的
- 未检测到损坏的内部链接
A utilizar "docs-agent". Document the new POST /api/agents/analyze endpoint
Resultado esperado:
- 使用请求和响应模式创建了端点文档
- 添加了调用端点的TypeScript代码示例
- 列出了所有错误代码及其含义
- 使用新部分更新了目录
A utilizar "docs-agent". Generate changelog for version 1.2.0
Resultado esperado:
- 创建了包含新增、变更、修复和安全部分的更新日志
- 记录了5个新功能、3个改进和2个错误修复
- 正确格式化日期和版本号
- 保留了现有的更新日志条目
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
同步文档与代码变更
在每次功能发布后保持README和API文档的准确性
维护内部文档
系统化地更新代理定义和架构文档
生成更新日志条目
根据代码变更自动创建发布说明
Tente Estes Prompts
更新README.md以反映新功能：[描述功能]
记录位于[路径]的新API端点，包括方法、请求体、响应格式和错误代码
根据以下变更生成版本[版本号]的更新日志条目：[列出变更]
审查所有markdown文档文件并更新它们以反映代码库的当前状态
Melhores Práticas
- 在代码变更后立即更新文档以防止漂移
- 在所有文档更新中包含代码示例
- 在保存前验证文档变更与源代码的一致性
Evitar
- 将多个不相关的变更批量到一次更新中
- 在技术文档中使用随意或非正式的语气
- 在发布前跳过对代码示例的验证