How does Documentation Wizard prevent documentation rot?

The skill analyzes Git diffs and code changes to identify documentation sections that no longer match the implementation, flagging them for updates or auto-correcting them.

Can it generate documentation from code comments?

Yes, it extracts JSDoc, TypeDoc, and other structured comments to generate comprehensive API references, including examples and error cases.

What documentation formats does it support?

It primarily works with Markdown for READMEs and ADRs, while also supporting OpenAPI specs, GraphQL schemas, and standard JSDoc/TypeDoc formats.

How does it integrate with Oracle and Summoner?

It pulls design decisions from Summoner's Mission Control Documents and tribal knowledge or 'gotchas' from Oracle to enrich documentation with the 'why' behind the code.

Documentation Wizard

Name: Documentation Wizard
Author: Overlord-Z

byOverlord-Z

0•

Aprendizaje y Documentación

Maintains living documentation by synchronizing READMEs, API references, and architecture records with your evolving codebase.

Documentation Wizard transforms technical documentation from a static chore into a dynamic, automated process. By treating documentation as code, this skill ensures that project READMEs, API specifications, and Architecture Decision Records (ADRs) stay perfectly in sync with implementation. It leverages integrations with specialized tools like Oracle and Summoner to capture tribal knowledge and design intent, while providing automated validation to catch stale content, broken links, and outdated code examples. It is the ideal solution for teams that want high-quality, trustworthy documentation without the manual maintenance burden.

Características Principales

01Automated synchronization between source code, Git history, and documentation files.

02Auto-generation of Architecture Decision Records (ADRs) and structured API documentation.

03Deep integration with Oracle and Summoner to pull architectural context and design patterns.

04Automatic changelog and onboarding guide generation based on project evolution.

05Real-time validation for stale documentation, broken links, and non-runnable code examples.

060 GitHub stars

Casos de Uso

01Creating self-updating onboarding materials for new developers based on codebase patterns.

02Capturing and formalizing architectural decisions into ADRs to preserve project context.

03Maintaining accurate API documentation and READMEs during rapid development cycles.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add overlord-z/claudeshack documentation-wizard

For use in Claude.ai and ChatGPT

Download Skill