Skill-Details

documentation-generator

Generates technical and onboarding documentation from source code.

ÜbereinstimmungDirektGeprüft für dokumentation
Quellejorgealves/agent_skillsExterne Quelle
Gemeldete Installationen240Nur Popularitätssignal

Vor Nutzung prüfen

Die automatische Prüfung bewertet Relevanz, nicht Sicherheit oder Empfehlung. Lies vor der Nutzung die Quellanweisungen.

Gespeicherte Quellvorschau

SKILL.md

Dieser Auszug wurde bei der Prüfung gespeichert. Die externe Quelle enthält die vollständige und aktuelle Version.

---
name: documentation-generator
description: 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.
---
# 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.
Vollständige Quelle auf GitHub lesen (öffnet externe Seite)
Kontext

Verwandte Arbeit