write-doc

Author and edit Markdown documents under docs/ following project conventions and scaffold rules.

Updated Mar 21, 2026
One-click install
npx skills add https://github.com/mikestopcontinues/agent-skills --skill write-doc-mikestopcontinues
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-doc
Source: https://github.com/mikestopcontinues/agent-skills/tree/main/claude/skills/write-doc
Command: npx skills add https://github.com/mikestopcontinues/agent-skills --skill write-doc-mikestopcontinues

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping a growing docs/ tree consistent is hard: numbering schemes, frontmatter schemas, link discipline, and file-size limits all drift when docs are written ad hoc. This Skill enforces those conventions for every doc write or edit, whether it is a new chapter in a spike or plan, a frontmatter touch-up, or a restructure of an existing document. ## Core Features & Use Cases - Scaffold enforcement: New prefixed top-level docs (spikes, plans, notes) must be created through the yolo new CLI, which assigns numbers, seeds frontmatter, and returns the canonical path; direct writes are blocked by the pre-write-doc hook. - Convention-guided editing: Applies project doc rules such as the ~500-line soft cap, one topic per file, Mermaid diagrams, TypeScript-style types, and file-level-only cross-references (no #anchor fragments). - Validation and handoff: Runs doc-check-links.sh when cross-references change, re-reads edited files, and uses git mv for renames. - Use Case: While executing a plan, you need a new chapter 04-rollout.md inside docs/plans/p018-auth/. The Skill reads sibling chapters for tone, writes the chapter matching local conventions, links it file-level to siblings, and verifies links before reporting back. ## Quick Start Ask the agent to write a new chapter about rollout strategy in the existing plan directory docs/plans/p018-auth following the project doc conventions.

Frequently Asked Questions about write-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a new numbered spike or plan document?▼

New prefixed top-level docs like docs/spikes/sNNN-name/README.md must be created with the yolo new scaffold CLI, which assigns the next free number, seeds frontmatter, and returns the file path. Writing the file directly is blocked by the pre-write-doc hook.

How do I edit an existing doc without breaking conventions?▼

Read the target file and its directory's README first, then edit while preserving existing frontmatter fields and matching sibling chapters' tone and structure. Keep files under the ~500-line soft cap and re-read the file end-to-end after editing.

Can I use anchor links like file.md#section in cross-references?▼

No. Cross-references are file-level only; anchor fragments are forbidden by the d06 decision. If a section is hard to find without an anchor, the target file is too long and should be split into smaller files.

When should I not use this doc-writing workflow?▼

Use review-doc for reviewing a doc, revise-doc for applying review findings, create-decision for locked decisions, write-convention for convention files, and create-spike or create-plan when starting a new research or spec lifecycle.

Why was my direct Write to a new docs file blocked?▼

The pre-write-doc hook blocks direct creation of new prefixed top-level docs such as spikes, plans, and top-level notes. Run the yolo new scaffold command instead, then edit the generated file directly.