hatch3r-docs-writing
SolidAuthors technical documentation through a repeatable workflow — audience analysis, Diátaxis-mode selection, structure, draft, review, publish. Covers READMEs, ADRs, API docs, and runbooks. Use when writing or restructuring any project documentation.
Install
Quality Score: 83/100
Skill Content
Details
- Author
- hatch3r
- Repository
- hatch3r/hatch3r
- Created
- 5 months ago
- Last Updated
- 1 weeks ago
- Language
- TypeScript
- License
- MIT
Integrates with
Bundled in these plugins
Similar Skills
Semantically similar based on skill content — not just same category
technical-writing
Use to author or review developer- and user-facing documentation — API reference, admin/developer/user guides, runbooks, release notes, tutorials, how-to guides, conceptual explanations, and ADR polish. Use whenever a feature changes public behavior and needs docs, when shipping a runbook or release notes, or when judging whether docs are GA-ready. Structures every page with the Diataxis framework and enforces the Google + Microsoft style guides.
writing-docs
Use when writing, restructuring, or reviewing any prose documentation — a tutorial, how-to guide, reference page, or explanation/conceptual doc — for a public docs site (e.g. Mintlify MDX, docs/, README material), a getting-started guide, an API/CLI reference page, or a "why we built it this way" conceptual page. Applies the Diátaxis framework (see https://diataxis.fr/) — every document belongs to exactly one of the four quadrants (tutorial / how-to guide / reference / explanation), and mixing quadrants inside one document is the single most common documentation failure. Covers the four-quadrant compass for picking the right form, per-quadrant structure templates, an anti-pattern list for quadrant drift, and generic voice/craft rules — repo-specific voice and target output format (e.g. Mintlify MDX) are resolved from the repo's docs-manifest (falling back to project-context), never hardcoded here.
documentation
Technical documentation writing and maintenance. Modes — readme, runbook, api, onboarding. Uses writer agent principles for audience-appropriate, maintainable docs.