repo-docs
生成仓库文档
代码仓库中的文档往往过时或缺失。此技能分析代码库结构，生成全面的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 "repo-docs". 为此仓库生成文档
Resultado esperado:
- ## README.md - 项目标题、描述、快速入门、使用示例、集成部分
- ## API.md - 基础 URL、身份验证、包含参数和响应的端点
- ## CONTRIBUTING.md - 先决条件、设置步骤、测试说明
A utilizar "repo-docs". 为我的微服务创建集成文档
Resultado esperado:
- ## INTEGRATIONS.md - 上游服务及其用途
- ## 此服务的下游消费者
- ## 数据流图表和通信协议
Auditoria de Segurança
Baixo RiscoDocumentation generation skill with clean security posture. All static findings are FALSE POSITIVES caused by the scanner misinterpreting markdown template code blocks and pattern definitions as actual security-relevant code. The Python scripts perform safe static analysis (file reading and pattern matching) without executing code or making network calls. The skill only reads repository files locally and outputs documentation to stdout.
Fatores de risco
⚡ Contém scripts (1)
📁 Acesso ao sistema de arquivos (1)
Pontuação de qualidade
O Que Você Pode Construir
文档化微服务生态系统
映射服务之间的依赖关系并为分布式系统生成集成文档
创建项目文档
为公共仓库生成专业的 README、API 文档和贡献指南
标准化文档
在整个组织的多个仓库中应用一致的文档模板
Tente Estes Prompts
为此仓库生成 README.md。包括项目描述、快速入门说明、使用示例以及与其他仓库的集成点。
为此项目创建 API.md 文档。列出所有包含请求/响应示例的端点、身份验证要求和错误处理。
为此仓库生成 ARCHITECTURE.md。包括系统概述、组件图表、跨仓库依赖关系以及服务之间的数据流。
生成 CONTRIBUTING.md，包含开发设置步骤、测试说明、代码风格指南以及相关仓库的链接。
Melhores Práticas
- 在干净的代码副本上运行此技能，以确保示例与当前代码匹配
- 在提交生成的文档之前审查和自定义模板
- 添加新集成或更改架构时更新文档
Evitar
- 期望此技能自动执行代码或运行测试
- 使用生成的文档而不验证其准确性
- 忽略文档中的跨仓库集成点