Skip to content
Skills Library
Programming · Writing

write-doc

/write-doc

Creates or updates a documentation page in docs/ using the right Diataxis type, valid front matter and a one-sentence summary. Use whenever adding, changing, moving or deleting a doc.

Licence
MIT
Last repository change
13.11.2026

Assessment and security

86/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content21 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 13.11.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Creates or updates a documentation page in docs/ using the right Diataxis type, valid front matter and a one-sentence summary. Use whenever adding, changing, moving or deleting a doc.

Original author description

Creates or updates a documentation page in docs/ using the right Diataxis type, valid front matter and a one-sentence summary. Use whenever adding, changing, moving or deleting a doc.

How it works

SKILL.md has no level-two headings · 19 lines, 207 words

SKILL.md preview
---
name: write-doc
description: Creates or updates a documentation page in docs/ using the right Diataxis type, valid front matter and a one-sentence summary. Use whenever adding, changing, moving or deleting a doc.
---
# Write a doc

**Role:** the owner of the folder you are changing (see `agents/ROSTER.md`); usually the scribe. Docs in other roles' folders: hand the change to that role.

1. Pick exactly one type by the reader's need:
   - **tutorial**: a beginner learns by doing; the steps must work every time.
   - **how-to**: someone who knows the basics solves one task; a recipe.
   - **reference**: someone looks up a fact; accurate, complete, no opinions or instructions.
   - **explanation**: someone wants to understand why; context, trade-offs, history.
   If the page needs two types, write two pages and link them.
2. Check `docs/INDEX.md` first. Update an existing page rather than adding a near-duplicate.
3. Create it: `python3 tools/new_doc.py <type> "Title" --summary "One sentence a stranger can judge by."`
4. Fill it from the template. Keep it focused; split when it passes about 300 lines.
5. If it describes code, list the files under `related_code` in the front matter and set `last_verified` to today.
6. Delete or mark `deprecated` anything the change makes wrong. Stale docs are worse than none.
7. `python3 tools/sync_indexes.py && python3 tools/check.py`.

Do not link from core docs into optional module folders (the check will fail); use backticks. Do not hand-edit generated files such as `docs/INDEX.md`.

Versions

The database has no other skills named write-doc.

Database snapshot: 13.11.2026 · package version 8ed4804a5333 (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

  • 95Diataxis-Documentation
    Diataxis-based documentation methodology for creating, organizing, and planning documentation. USE WHEN user says 'set up docs', 'create documentation', 'document this project', 'plan documentation', 'organize docs', 'restructure docs', 'getting started guide', 'write a…
  • 100docs-creator
    Create or improve documentation files with Diataxis-aware placement and consistent naming. Use when the user wants to create any new documentation, improve existing docs, write a README, or restructure documentation. Also use when asked to "write docs", "improve this doc", "add…
  • 100docs-creator
    Create or improve documentation files with Diataxis-aware placement and consistent naming. Use when the user wants to create any new documentation, improve existing docs, write a README, or restructure documentation. Also use when asked to "write docs", "improve this doc", "add…
  • 100diataxis-write-docs
    Draft or revise project documentation for the reader's purpose using Diataxis. Use for writing tutorials, how-to guides, reference, or explanation; use diataxis-organize-docs for reorganizing an existing documentation collection.
  • 100docs-writing
    Use when asked to write, restructure, or audit documentation with Diataxis types, or to draft a feature docs page or diagram source. Not for ADRs or architectural rationale.
  • 100documentation-standards
    This skill should be used when the user asks to "write documentation", "create docs", "document code", "improve documentation", "documentation best practices", "diataxis", "technical writing", "API documentation", "user guide", mentions documentation quality, documentation…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.