writing-documentation

Writes structured Markdown documentation for software components and developer guides.

Updated Aug 28, 2026
One-click install
npx skills add https://github.com/epicodic/drift --skill writing-documentation-epicodic
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-documentation
Source: https://github.com/epicodic/drift/tree/main/.agents/skills/writing-documentation
Command: npx skills add https://github.com/epicodic/drift --skill writing-documentation-epicodic

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing consistent, well-placed developer documentation is slow and error-prone: pages end up in the wrong location, lack structure, or skip review steps. This Skill enforces a disciplined nine-step workflow that produces focused Markdown documentation with confirmed placement, reviewed structure, and consistent formatting. ## Core Features & Use Cases - Placement rules: Routes component docs to <component>/docs/ and guides or architecture topics to docs/, with a confirmation step before creating files. - Staged authoring workflow: Clarifies scope, gathers source material, proposes location, drafts heading-only structure for approval, then writes content and wires the page into the docs tree. - Writing guidelines: Enforces one sentence per line, Mermaid diagrams, LaTeX math, code blocks, and a standard component template covering purpose, inputs/outputs, algorithm, data structures, and integration points. - Use Case: After adding a new tiling algorithm module, ask the assistant to document it; the Skill reads the source, proposes snp/<component>/docs/index.md, drafts headings for your review, then writes the full page with a Mermaid data-flow diagram. ## Quick Start Ask the assistant to write documentation for a specific component or feature and follow its step-by-step prompts to confirm scope, location, and structure.

Frequently Asked Questions about writing-documentation

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

FAQPage Schema
How do I write documentation for a software component?▼

Follow the nine-step process: clarify scope, read the source files, propose a location, create a headings-only draft for review, then write the content. Component docs go in the component's docs/ directory and cover purpose, inputs/outputs, algorithm, data structures, and integration points.

Where should developer documentation files be placed?▼

Component documentation lives alongside the code in <component>/docs/, while developer guides and architecture topics go in the central docs/ directory. The Skill asks you to confirm the proposed path before creating any file.

What formatting rules does the documentation follow?▼

Pages are plain Markdown with one sentence per line, one idea per paragraph, and clear heading hierarchy. Diagrams use Mermaid, formulas use LaTeX inline or block math, and examples use language-tagged code blocks.

Can I review the document structure before content is written?▼

Yes. Step 4 creates the file with headings only and waits for your explicit approval before any body text is written. You can edit the headings directly, and the Skill re-reads the file after approval.

Does the documentation require a build step to verify?▼

No documentation build command is configured in this repository. Verification is done by reviewing Markdown structure and links directly, plus any repository-provided link or Markdown checks when they exist.