documentation-generator

Generate READMEs, ADRs, changelogs, and JSDoc documentation for software projects.

Updated Oct 2, 2025
One-click install
npx skills add https://github.com/YuriiYInno/Innogram --skill documentation-generator-yuriiyinno
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-generator
Source: https://github.com/YuriiYInno/Innogram/tree/main/.codex/skills/documentation-generator
Command: npx skills add https://github.com/YuriiYInno/Innogram --skill documentation-generator-yuriiyinno

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping project documentation accurate and consistent is tedious: READMEs drift out of date, architectural decisions go unrecorded, and changelogs get skipped. This Skill standardizes the creation and maintenance of project documentation so it stays synchronized with the actual codebase. ## Core Features & Use Cases - Multiple Documentation Types: Provides ready-to-use templates for library READMEs, domain READMEs, Architecture Decision Records (ADRs), changelog entries, and JSDoc comments. - Living Specification Updates: Maintains a specs/docs-generator-implementation.md file documenting build processes, deployment, tooling, and development workflows, updated whenever configuration changes. - Consistency Enforcement: Applies a mandatory docs-generator- file naming convention and a documentation checklist covering new libraries, features, and code changes. - Use Case: After shipping a new API module, ask the Skill to update the README, add a changelog entry, write an ADR for the design decision, and refresh the implementation spec in one pass. ## Quick Start Ask the assistant to generate a README and changelog entry for the module you just finished implementing.

Frequently Asked Questions about documentation-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README for a new library or module?▼

Use the library README template, which includes Overview, Installation, Usage with TypeScript examples, API Reference, Configuration, and Testing sections. The Skill reads your source code and living specs to fill in accurate content.

How do I write an Architecture Decision Record (ADR)?▼

Use the ADR template with sections for Status, Context, Decision, and Consequences (positive, negative, neutral). Number it sequentially (ADR-NNNN) and store it in the docs/adrs/ directory.

What documentation should be updated when a feature changes?▼

Update the README if usage changed, add a changelog entry, write an ADR if an architectural decision was made, refresh JSDoc for changed interfaces, and update the implementation spec if build or deployment processes changed.

Does this Skill update existing documentation or only create new files?▼

It does both. It reads existing specs like specs/MANIFEST.md and other spec files for context, then appends dated task sections to living documents or creates new files following the docs-generator- naming convention.

What is the docs-generator- file naming convention?▼

Any ad-hoc file created by the Skill must be prefixed with docs-generator-, such as docs-generator-api-reference.md. Standard project files like README.md and CHANGELOG.md are exempt from this rule.