project-documentation

To generate a README and ADR, the skill uses established templates and best practices to produce comprehensive technical documentation covering architecture decisions, API details, and operational runbooks. It ensures all generated files are accurate and maintainable.

The best way to structure technical documentation is to cover READMEs, database schemas, deployment guides, changelogs, contribution guidelines, and security documentation. This skill enforces a quality checklist to ensure the output is tested and understandable by junior developers.

Yes, you can create deployment guides and operational runbooks for existing codebases. The skill generates accurate, tested documentation following established templates, ensuring your existing project needs are covered and maintainable over time.

Yes, this documentation approach includes API docs and contribution guidelines. It generates comprehensive technical documentation covering these formats alongside changelogs and security documentation, ensuring all project files follow established best practices.

To ensure your generated API documentation is accurate and maintainable, the skill enforces a quality checklist that verifies all documentation is tested and understandable by junior developers. This prevents documentation debt and ensures long-term project maintainability.