Compétences code-documentation-doc-generate
📦
code-documentation-doc-generate
Sûr
自动生成代码文档
通过AI驱动的分析，从源代码创建全面的API文档、架构图、用户指南和技术参考资料。
Prend en charge: Claude Codex Code(CC)
1
Télécharger le ZIP du skill
2
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
3
Activez et commencez à utiliser
Tester
Utilisation de "code-documentation-doc-generate". 为具有创建、读取、更新、删除用户端点的FastAPI用户服务生成API文档
Résultat attendu:
- API Documentation created with:
- - OpenAPI 3.0 specification
- - User endpoints (/users, /users/{id})
- - Request/response schemas with validation
- - Authentication and authorization sections
- - Example curl commands for each endpoint
Utilisation de "code-documentation-doc-generate". 为将图像转换为PDF的Python CLI工具创建README
Résultat attendu:
- README generated with:
- - Project title and description
- - Installation instructions (pip, conda)
- - Quick start guide with examples
- - Configuration options table
- - License and contribution guidelines
Audit de sécurité
Sûrv1 • 2/25/2026
All 91 static findings are false positives triggered by documentation examples in the skill. The skill provides templates and examples for generating documentation. No actual code execution, network calls, or credential access occurs. Risk level: SAFE.
2
Fichiers analysés
692
Lignes analysées
1
résultats
1
Total des audits
Problèmes à risque faible (1)
Static Scanner Pattern Detection in Documentation Examples
The static scanner detected 91 potential security patterns in documentation examples. These findings are false positives triggered by template variables (${VARIABLE}), code block fences (```), and example URLs in the implementation playbook. No actual code execution, network calls, or credential access occurs.
Audité par: claude
Score de qualité
38
Architecture
100
Maintenabilité
87
Contenu
50
Communauté
100
Sécurité
100
Conformité aux spécifications
Ce que vous pouvez construire
Web服务的API文档
从REST端点代码自动生成OpenAPI规范和交互式API文档
项目README生成
创建包含安装、使用示例和贡献指南的全面README文件
架构文档
从代码结构生成系统架构图和组件文档
Essayez ces prompts
基础API文档
为此代码库中的端点生成API文档。包括请求/响应模式、身份验证要求和示例请求。
完整项目README
为此项目创建一个全面的README.md。包括：项目描述、安装步骤、使用示例、配置选项和贡献指南。
架构概览
分析代码库结构并生成架构文档。包括系统图、组件描述、数据流和技术栈摘要。
文档自动化设置
为此项目设置自动化文档生成。包括CI/CD配置、文档检查规则和部署到文档托管平台。
Bonnes pratiques
- 始终通过测试验证生成的文档与实际代码行为是否匹配
- 使用CI/CD自动化保持文档与代码同步
- 包含用户可以复制和改编的实际代码示例
Éviter
- 生成文档而不审核其准确性
- 在公共文档中包含敏感信息，如API密钥或内部URL
- 创建无法自动验证或测试的文档
Foire aux questions
此技能可以生成哪些类型的文档？
此技能可以生成API文档、架构图、README文件、用户指南和技术参考资料。它支持OpenAPI/Swagger规范、Mermaid图表和各种文档格式。
此技能会在我的项目上执行代码吗？
不会。此技能会分析您的代码以了解其结构，并基于该分析生成文档。它不会修改或执行您的代码库。
我可以将其集成到CI/CD管道中吗？
可以。该技能包含使用GitHub Actions、GitLab CI或类似平台在CI/CD管道中设置自动化文档生成的指南。
支持哪些编程语言？
该技能适用于任何编程语言。它分析代码结构并生成与语言无关的文档。具体语言支持取决于文档格式（例如，JavaScript的JSDoc、Python的文档字符串）。
如何保持文档与代码同步？
在CI管道中设置自动化文档生成，使其在每次提交时运行。您还可以使用文档检查工具在部署前发现不一致之处。
此技能可以为私有或内部API生成文档吗？
可以。该技能可以为任何API生成文档。但是，请务必审核生成的文档，以在外部共享之前删除任何敏感的内部URL、凭据或专有信息。