Skip to main content
skill CX Codex

docs-writer — Claude Code skill: what it does, how to install

The docs-writer skill creates, edits, and reviews project documentation. Use it for READMEs, Markdown files, and pages under docs/.

MIT ★ 7,191 updated 2026-10-24

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add tech-leads-club/agent-skills --skill docs-writer -a claude-code
Open on GitHub

What docs-writer does

docs-writer guides an agent through documentation work from the initial request to the final check. It distinguishes new writing from editing, inspects relevant code in packages/, locates files in docs/, and checks related pages, links, and docs/sidebar.json.

The workflow follows CONTRIBUTING.md and references/style-guide.md. Changes use replace for small edits and write_file for new files or larger rewrites. Afterward, the agent rereads the result, checks links, and offers the npm run format command.

This skill is not meant for code comments, inline JSDoc, or API reference generation.

What it helps with

  • write a README for a new feature
  • review a Markdown file for clarity and style
  • update docs/ after a code change
  • check related links and docs/sidebar.json

Example prompts for the agent

  • Write documentation for the new feature after inspecting the code in packages/.
  • Review this README against references/style-guide.md and fix the issues you find.
  • Update the relevant files in docs/, check linked pages, and offer npm run format.

How to install docs-writer

1Skills CLI (Vercel)

npx skills add tech-leads-club/agent-skills --skill docs-writer -a claude-code

2Manually: put the files in place

~/.claude/skills/docs-writer/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/docs-writer/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about docs-writer

How do I install docs-writer in Claude Code?

Run npx skills add tech-leads-club/agent-skills --skill docs-writer -a claude-code, then use ~/.claude/skills/docs-writer/SKILL.md.

What does docs-writer do?

It guides an agent in writing, editing, and reviewing project documentation. The workflow checks the implementation, related pages, links, and project style rules.

Can docs-writer generate API references or code comments?

No. It targets documentation files, READMEs, and Markdown, rather than code comments, inline JSDoc, or API reference generation.

Source text

SKILL.md · MIT
---
name: docs-writer
description: Write, review, and edit documentation files with consistent structure, tone, and technical accuracy. Use when creating docs, reviewing markdown files, writing READMEs, updating `/docs` directories, or when user says "write documentation", "review this doc", "improve this README", "create a guide", or "edit markdown". Do NOT use for code comments, inline JSDoc, or API reference generation.
---

# `docs-writer` skill instructions

As an expert technical writer and editor, your goal is to produce and refine documentation that is accurate, clear, consistent, and easy for users to understand. You must adhere to the documentation contribution process outlined in `CONTRIBUTING.md`.

## Step 1: Understand the goal and create a plan

1. **Clarify the request:** Fully understand the user's documentation request. Identify the core feature, command, or concept that needs work.
2. **Differentiate the task:** Determine if the request is primarily for **writing** new content or **editing** existing content. If the request is ambiguous (e.g., "fix the docs"), ask the user for clarification.
3. **Formulate a plan:** Create a clear, step-by-step plan for the required changes.

## Step 2: Investigate and gather information

1. **Read the code:** Thoroughly examine the relevant codebase, primarily within the `packages/` directory, to ensure your work is backed by the implementation and to identify any gaps.
2. **Identify files:** Locate the specific documentation files in the `docs/` directory that need to be modified. Always read the latest version of a file before you begin work.
3. **Check for connections:** Consider related documentation. If you change a command's behavior, check for other pages that reference it. If you add a new page, check if `docs/sidebar.json` needs to be updated. Make sure all links are up to date.

## Step 3: Write or edit the documentation

1. **Follow the style guide:** Adhere to the rules in `references/style-guide.md`. Read this file to understand the project's documentation standards.
2. Ensure the new documentation accurately reflects the features in the code.
3. **Use `replace` and `write_file`:** Use file system tools to apply your planned changes. For small edits, `replace` is preferred. For new files or large rewrites, `write_file` is more appropriate.

### Sub-step: Editing existing documentation (as clarified in Step 1)

- **Gaps:** Identify areas where the documentation is incomplete or no longer reflects existing code.
- **Tone:** Ensure the tone is active and engaging, not passive.
- **Clarity:** Correct awkward wording, spelling, and grammar. Rephrase sentences to make them easier for users to understand.
- **Consistency:** Check for consistent terminology and style across all edited documents.

## Step 4: Verify and finalize

1. **Review your work:** After making changes, re-read the files to ensure the documentation is well-formatted, and the content is correct based on existing code.
2. **Link verification:** Verify the validity of all links in the new content. Verify the validity of existing links leading to the page with the new content or deleted content.
3. **Offer to run npm format:** Once all changes are complete, offer to run the project's formatting script to ensure consistency by proposing the command: `npm run format`

© tech-leads-club · MIT · tech-leads-club/agent-skills

Similar skills

All skills for Writing and docs →

From the same set130

The whole set →
state-decouple-implementation state-decouple-implementation — a Claude Code rule that keeps state management inside providers and exposes only a context interface to UI components. Swap useState for Zustand or a server sync without touching a single UI file. CX Codex +1 ★ 7,191repo stars rerender-functional-setstate The rerender-functional-setstate rule recommends functional state updates when the next React value depends on the current one. It helps callbacks avoid stale state and unnecessary dependencies. CX Codex +1 ★ 7,191repo stars state-lift-state state-lift-state — a Claude Code rule that moves React state into a provider component, so siblings outside the main UI read and update it without prop drilling or refs. CX Codex +1 ★ 7,191repo stars js-batch-dom-css js-batch-dom-css prevents layout thrashing by separating style updates from layout queries. Helps Claude write performant DOM and React code. CX Codex +1 ★ 7,191repo stars perf-astro The perf-astro Claude Code skill tunes Astro builds with inlined critical CSS, minification, non-blocking fonts and an LCP preload, aiming for 95+ Lighthouse scores. CX Codex +1 ★ 7,191repo stars tactical-ddd Audits domain models for anemia and refactors them into rich aggregates using tactical DDD patterns in Claude Code. CX Codex +1 ★ 7,191repo stars nx-workspace nx-workspace — a skill for exploring an Nx monorepo from the CLI: list projects, read resolved config, find affected projects and wire affected commands into CI. CX Codex +1 ★ 7,191repo stars perf-web-optimization perf-web-optimization guides front-end performance tuning by shrinking JS bundles, deferring heavy scripts, and configuring cache headers. Best when pages load slowly or fail speed benchmarks. CX Codex +1 ★ 7,191repo stars

Project sponsors

Companies that keep this analytics open