write-documentation
/write-documentation
Write software documentation structured by Diátaxis. Use when the user wants a tutorial, how-to guide, reference page, explanation doc, or user guide — "write docs", "document this", "we need a guide for X". Not for READMEs (write-readme) or docstrings (update-docstrings).
- Author
- yassimba ↗
- Repository
- loom ↗
- Licence
- Apache-2.0
- Last repository change
- 27.10.2026
Assessment and security
- Files in this package
- 7
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 27.10.2026, without references to retired models or APIs.
Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.
What it does and when to use it
Write software documentation structured by Diátaxis. Use when the user wants a tutorial, how-to guide, reference page, explanation doc, or user guide — "write docs", "document this", "we need a guide for X". Not for READMEs (write-readme) or docstrings (update-docstrings).
Triggers from the description
Original author description
Write software documentation structured by Diátaxis. Use when the user wants a tutorial, how-to guide, reference page, explanation doc, or user guide — "write docs", "document this", "we need a guide for X". Not for READMEs (write-readme) or docstrings (update-docstrings).
How it works
- Workflow
- Sources
SKILL.md preview
--- name: write-documentation description: 'Write software documentation structured by Diátaxis. Use when the user wants a tutorial, how-to guide, reference page, explanation doc, or user guide — "write docs", "document this", "we need a guide for X". Not for READMEs (write-readme) or docstrings (update-docstrings).' --- # Write Documentation (Diátaxis) Produce one document per run, typed by the Diátaxis quadrant it serves: a **tutorial** (a lesson), a **how-to guide** (a recipe), **reference** (a dictionary), or an **explanation** (a discussion). ## Workflow 1. **Classify.** Place the request on the Diátaxis compass: - Does the document serve the reader's _action_ (they are doing something) or _cognition_ (they are understanding something)? - Does it serve _acquisition_ (they are studying) or _application_ (they are working)? | | acquisition (study) | application (work) | | ------------- | ------------------- | ------------------ | | **action** | tutorial | how-to guide | | **cognition** | explanation | reference | A request that spans quadrants is more than one document — say so and pick the primary one for this run. 2. **Confirm the brief.** State your classification and ask about whatever is still unknown of: - **Audience** — who reads this, and what do they already know? - **Reader's goal** — what can they do or understand after reading? - **Scope** — what is in, and what is explicitly out? Done when document type, audience, goal, and scope are each either answered by the user or proposed by you and accepted. 3. **Load the applicable rules.** Read the matching quadrant file before outlining: - Tutorial → [references/tutorial.md](references/tutorial.md) - How-to guide → [references/how-to.md](references/how-to.md) - Reference → [references/reference.md](references/reference.md) - Explanation → [references/explanation.md](references/explanation.md) When classification remains uncertain or existing material needs diagnosis, read [the compass](references/compass.md). When improving existing documentation or deciding how to reorganise a set, read [the workflow](references/workflow.md), then select one document for this run. 4. **Propose an outline.** A table of contents, one line per section, shaped by the applicable rules. Await approval before writing. 5. **Write.** Done when every section of the approved outline is fully written — none stubbed, summarized, or deferred. ## Sources Work only from material the user provides and the codebase at hand. Provided markdown files calibrate tone and terminology; quote them only on request. Verify every product claim, command, signature, and snippet against the actual code before including it.
Files in this package (7)
- SKILL.md 3 KB
- references/compass.md 2 KB
- references/explanation.md 3 KB
- references/how-to.md 3 KB
- references/reference.md 3 KB
- references/tutorial.md 4 KB
- references/workflow.md 2 KB
Versions
The database has no other skills named write-documentation.
Database snapshot: 13.11.2026 · package version de276e5c996a (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100documentation
Creates, structures, and reviews technical documentation following the Diátaxis framework (tutorials, how-to guides, reference, and explanation pages). Use when a user needs to write or reorganize docs, structure a tutorial vs. a how-to guide, build reference docs or API… - 85diataxis
Write or review documentation using the Diátaxis framework. Use when the user asks for a tutorial, how-to guide, technical reference, explanation/conceptual doc, README, a documentation plan, or a review/audit of existing docs. Classifies the request into the right quadrant and… - 100doc-gen
Generate documentation from source code — docstrings, READMEs, API references. Triggers on: generate docs, write documentation, document this, create README, API docs, doc-gen. - 100absolute-docs
Diátaxis-driven documentation for AI coding agents: write, improve, or audit tutorials, how-tos, reference, explanation, and developer docs (README, CONTRIBUTING, ADRs). Detects the docs stack; gates on the outline before writing prose; verifies every claim against the code… - 100documentation-writer
Create or revise software documentation using the Diátaxis distinction between tutorials, how-to guides, reference, and explanation. Use for README sections, product and API documentation, operational guides, onboarding material, or restructuring an existing documentation set. - 100documentation-generation
Generates project documentation including READMEs, docstrings (JSDoc, JavaDoc, Python docstrings), OpenAPI prose, and CI/CD doc pipelines. Use when asked to generate docs, write docstrings, automate documentation, or create README files.