hatch3r-docs-writing

Solid

Authors 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.

AI & Automation 26 stars 4 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
48
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Technical Documentation Workflow Companion workflow to the `hatch3r-docs-writer` agent: that agent is the Phase-4 specialist invoked to update specs after a code change; this skill is the step-by-step procedure a human or agent follows to author a documentation artifact from scratch. Use the agent when documentation must track a `src/` diff; use this skill when authoring a new doc and you need the audience-analysis-through-publish sequence. ## Quick Start ``` Task Progress: - [ ] Step 0: Detect ambiguity (P8 B1) - [ ] Step 1: Classify the doc by Diátaxis mode + name the audience - [ ] Step 2: Pick the structure template for the chosen mode - [ ] Step 3: Draft to the template, one mode per document - [ ] Step 4: Run the review checklist (audience, accuracy, style, structure) - [ ] Step 5: Publish — link from an index, set owner + last-updated, verify cross-references ``` The load-bearing decision is Step 1: a document serves exactly one of four user needs. Mixing learning content into a reference table, or burying a how-to procedure inside an explanation, is the most common defect this workflow prevents (Diátaxis — see References). ## Step 0 — Detect Ambiguity (P8 B1) Before any work, scan the invocation for unresolved questions in scope, intent, acceptance criteria, target audience, or irreversibility. If any are found, ask the user via the platform-native question tool per `agents/shared/user-question-protocol.md`. Do not proceed under silent assumption. Default path...

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

Code & Development Listed

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.

1 Updated 2 weeks ago
StielChancellor
AI & Automation Listed

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.

3 Updated 5 days ago
whimzyLive
Code & Development Solid

documentation

Technical documentation writing and maintenance. Modes — readme, runbook, api, onboarding. Uses writer agent principles for audience-appropriate, maintainable docs.

40 Updated 2 days ago
drafthq