Automates the creation and validation of project documentation using the GoodDocs framework and templates.
The GoodDocs Author skill streamlines the technical documentation process by guiding users through a structured authoring workflow. It automatically handles administrative tasks such as incrementing document IDs, generating kebab-case filenames, and updating the central README index. By prompting for essential sections like motivation and proposed solutions, and running integrated validation scripts to catch errors, it ensures that every new document adheres to high-quality standards and project-specific rules.
Key Features
01Pre-publication validation using custom Python scripts to ensure compliance
02Automatic updates to the central documentation index in README.md
032 GitHub stars
04Interactive prompts for structured document sections (Motivation, Solution, Alternatives)
05Seamless integration with repo.config.json for default ownership and settings
06Automated numeric ID generation and kebab-case file naming
Use Cases
01Maintaining a standardized documentation library across large development teams
02Enforcing documentation metadata and validation rules automatically via CLI
03Drafting technical RFCs or Architecture Decision Records (ADRs) with consistent formatting
