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 6 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
48
Recency 20%
100
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
7 months ago
Last Updated
yesterday
Language
TypeScript
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category