docs-writer

Write, review, and edit Markdown documentation following a defined style guide.

Updated Sep 15, 2026
One-click install
npx skills add https://github.com/Peterson-Benhame/agent-skills --skill docs-writer-peterson-benhame
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/Peterson-Benhame/agent-skills/tree/main/packages/skills-catalog/skills/%28development%29/docs-writer
Command: npx skills add https://github.com/Peterson-Benhame/agent-skills --skill docs-writer-peterson-benhame

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Keeping project documentation accurate, consistent, and aligned with the actual codebase is tedious and error-prone. This Skill guides an AI agent through a structured process for writing new docs and editing existing ones so they match the implementation and follow a consistent style. ## Core Features & Use Cases - Structured writing workflow: Follows a four-step process covering planning, codebase investigation, writing or editing, and final verification. - Style guide enforcement: Applies the rules in references/style-guide.md covering tone, grammar, formatting, terminology, and accessibility. - Link and sidebar maintenance: Checks related pages, validates links, and updates docs/sidebar.json when pages are added or removed. - Use Case: Ask the agent to update the README for a changed CLI command; it reads the relevant code in packages/, edits the doc, verifies links, and offers to run npm run format. ## Quick Start Ask the agent to review and improve the README file for clarity, accuracy, and consistency with the current code.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I write documentation that matches my codebase?

Read the relevant source code first to confirm actual behavior, then write docs that describe only what the code does. This Skill instructs the agent to investigate the packages directory before writing or editing any documentation file.

How to review and improve an existing README file?

Identify gaps where docs no longer reflect the code, fix passive voice and awkward wording, and check terminology consistency. The Skill follows an editing sub-process covering gaps, tone, clarity, and consistency before verifying links.

What style rules does the documentation follow?

The style guide in references/style-guide.md requires active voice, second person, present tense, sentence-case headings, serial commas, 80-character text wrapping, and descriptive link text. It also covers accessibility and filename conventions.

When should I not use this documentation skill?

Do not use it for code comments, inline JSDoc, or API reference generation, as stated in its description. It is scoped to prose documentation such as READMEs, guides, and docs directory pages.

Does the skill handle documentation navigation and links?

Yes. When adding a new page it checks whether docs/sidebar.json needs updating, and during finalization it verifies the validity of all links in new content and links pointing to changed or deleted pages.