Skills code-documentation-doc-generate
📦

code-documentation-doc-generate

Safe

Generate Code Documentation Automatically

Create comprehensive API documentation, architecture diagrams, user guides, and technical references from source code using AI-powered analysis.

Supports: Claude Codex Code(CC)
📊 71 Adequate
1

Download the skill ZIP

2

Upload in Claude

Go to Settings → Capabilities → Skills → Upload skill

3

Toggle on and start using

Test it

Using "code-documentation-doc-generate". Generate API documentation for a FastAPI user service with endpoints for create, read, update, delete users

Expected outcome:

  • 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

Using "code-documentation-doc-generate". Create a README for a Python CLI tool that converts images to PDF

Expected outcome:

  • README generated with:
  • - Project title and description
  • - Installation instructions (pip, conda)
  • - Quick start guide with examples
  • - Configuration options table
  • - License and contribution guidelines

Security Audit

Safe
v1 • 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
Files scanned
692
Lines analyzed
1
findings
1
Total audits
Low Risk Issues (1)
resources/implementation-playbook.md:1-641SKILL.md:1-51
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.
Audited by: claude

Quality Score

38
Architecture
100
Maintainability
87
Content
26
Community
100
Security
100
Spec Compliance

What You Can Build

API Documentation for Web Services

Automatically generate OpenAPI specs and interactive API docs from REST endpoint code

Project README Generation

Create comprehensive README files with installation, usage examples, and contribution guidelines

Architecture Documentation

Generate system architecture diagrams and component documentation from code structure

Try These Prompts

Basic API Documentation 
Generate API documentation for the endpoints in this codebase. Include request/response schemas, authentication requirements, and example requests.
Complete Project README 
Create a comprehensive README.md for this project. Include: project description, installation steps, usage examples, configuration options, and contribution guidelines.
Architecture Overview 
Analyze the codebase structure and generate architecture documentation. Include a system diagram, component descriptions, data flows, and technology stack summary.
Documentation Automation Setup 
Set up automated documentation generation for this project. Include CI/CD configuration, doc linting rules, and deployment to a documentation hosting platform.

Best Practices

  • Always verify generated documentation matches actual code behavior through testing
  • Keep documentation synchronized with code using CI/CD automation
  • Include practical code examples that users can copy and adapt

Avoid

  • Generating documentation without reviewing for accuracy
  • Including sensitive information like API keys or internal URLs in public docs
  • Creating documentation that cannot be verified or tested automatically

Frequently Asked Questions

What types of documentation can this skill generate?
This skill can generate API documentation, architecture diagrams, README files, user guides, and technical references. It supports OpenAPI/Swagger specs, Mermaid diagrams, and various documentation formats.
Does this skill execute code on my project?
No. This skill analyzes your code to understand its structure and generates documentation based on that analysis. It does not modify or execute your codebase.
Can I integrate this with my CI/CD pipeline?
Yes. The skill includes guidance for setting up automated documentation generation in CI/CD pipelines using tools like GitHub Actions, GitLab CI, or similar platforms.
What programming languages are supported?
The skill works with any programming language. It analyzes code structure and generates language-agnostic documentation. Specific language support depends on the documentation format (e.g., JSDoc for JavaScript, Docstrings for Python).
How do I keep documentation in sync with my code?
Set up automated doc generation in your CI pipeline to run on each commit. You can also use doc linting tools to catch inconsistencies before deployment.
Can this skill document private or internal APIs?
Yes. The skill can document any API. However, ensure you review generated documentation to remove any sensitive internal URLs, credentials, or proprietary information before sharing externally.

Developer Details

Author

sickn33

License

MIT

Repository

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/code-documentation-doc-generate

Ref

main

File structure

📁 resources/

📄 implementation-playbook.md

📄 SKILL.md