@jorgealves/documentation-generator

Analyzes source code to automatically generate technical documentation and architecture diagrams. Use to maintain up-to-date API references and onboarding materials for engineering teams.

View in AI SkillSafe app
Scanned · no findings
0 downloads
0 stars
0 demos
SKILL.md
namedocumentation-generator
descriptionAnalyzes source code to automatically generate technical documentation and architecture diagrams. Use to maintain up-to-date API references and onboarding materials for engineering teams.

Documentation Generator

Purpose and Intent

The documentation-generator ensures that software projects remain maintainable by automatically creating and updating technical documentation directly from the source code.

When to Use

  • Post-Development: Run after a feature is completed to ensure the API docs are up to date.
  • Onboarding: Use to generate architecture diagrams and overviews for new team members.

When NOT to Use

  • High-Level Strategy: This tool generates technical docs; it cannot write "Business Requirements" or "Product Vision" documents.

Security and Data-Handling Considerations

  • Operates locally; does not upload source code to external servers.

Embed badges

Add these to your README to show the skill's verification status.

SkillSafe verified badge
Verified badge
[![SkillSafe verified badge](https://api.skillsafe.ai/v1/badge/@jorgealves/documentation-generator/verified)](https://skillsafe.ai/skill/@jorgealves/documentation-generator/)
Installs badge
Installs badge
[![Installs badge](https://api.skillsafe.ai/v1/badge/@jorgealves/documentation-generator/installs)](https://skillsafe.ai/skill/@jorgealves/documentation-generator/)
Scan badge
Scan badge
[![Scan badge](https://api.skillsafe.ai/v1/badge/@jorgealves/documentation-generator/scan)](https://skillsafe.ai/skill/@jorgealves/documentation-generator/)
Eval pass rate badge
Eval pass rate
[![Eval pass rate badge](https://api.skillsafe.ai/v1/badge/@jorgealves/documentation-generator/eval)](https://skillsafe.ai/skill/@jorgealves/documentation-generator/)