docs-writer

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.

tech-leads-club/agent-skills|Updated May 23, 2026

Works with

Claude CodeCursorClineWindsurf

Installation Guide

Select your AI agent

How to use docs-writer on Cursor

AI-first code editor with Composer

Prerequisites

Before installing skills in Cursor, ensure your development environment meets these requirements:

›Cursor installed and configured on your machine
›Node.js 16+ with npm — verify with node --version
›Active project directory where you want to add docs-writer

Run the install command

Execute the skills CLI command in your project's root directory to begin installation:

$npx skills add https://github.com/tech-leads-club/agent-skills --skill docs-writer

Fetches docs-writer from tech-leads-club/agent-skills and configures it for Cursor.

Select Cursor when prompted

The CLI shows a list of agents. Use arrow keys and space to select Cursor:

◆ Which agents do you want to install to?

│

│ ── Universal (.agents/skills) ────────────────

│ · Cline · Codex · Goose · Windsurf

│ ●Cursor(selected)

│ · Cursor · Aider · Continue

Verify installation

Confirm successful installation by checking the skill directory location:

.cursor/skills/docs-writer

Restart Cursor to activate docs-writer. Access via /docs-writer in your agent's command palette.

⚠

Security Notice

We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.

Skills execute code in your environment. Always review source, verify the publisher, and test in isolation before production.

›View source on GitHub ›Skills CLI docs ›About Cursor ›What are agent skills?

Documentation

List & Monetize Your Skill

Submit your Claude Code skill and start earning

Get started →

Use Cases

Accelerate Code Development

Use skill to generate boilerplate code, refactor legacy code, and write tests faster

Example

Generate React component with TypeScript types, styled-components, and comprehensive test suite in minutes

✓

Reduce development time by 40-60% for repetitive coding tasks

Code Review Automation

Systematically review code for bugs, security issues, and style violations

Example

Analyze pull requests for common anti-patterns, suggest performance improvements, flag security vulnerabilities

✓

Catch 70%+ of code issues before human review, improve code quality

Debug Complex Issues

Trace errors through stack traces and identify root causes faster

Example

Analyze error logs, suggest probable causes, recommend fixes with code examples

Step 1: Understand the goal and create a plan

Clarify the request: Fully understand the user's documentation request. Identify the core feature, command, or concept that needs work.

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.

Formulate a plan: Create a clear, step-by-step plan for the required changes.

Step 2: Investigate and gather information

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.

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.

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

Follow the style guide: Adhere to the rules in references/style-guide.md. Read this file to understand the project's documentation standards.

Ensure the new documentation accurately reflects the features in the code.

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

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.

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.

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

docs-writer

Installation Guide

How to use docs-writer on Cursor

Prerequisites

Run the install command

Select Cursor when prompted

Verify installation

Security Notice

Documentation

List & Monetize Your Skill

Use Cases

Accelerate Code Development

Code Review Automation

Debug Complex Issues

Install Skill

`docs-writer` skill instructions

Step 1: Understand the goal and create a plan

Step 2: Investigate and gather information

Step 3: Write or edit the documentation

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

Step 4: Verify and finalize

Learn New Technologies

Implementation Guide

Best Practices

When to Use This

Learning Path

Integration

Related Skills

codenavi

create-rfc

roblox-game-development

pyqt6-ui-development-rules

react-nextjs-development

macos-development

Reviews

Discussion

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

Installation Guide

How to use docs-writer on Cursor

Prerequisites

Run the install command

Select Cursor when prompted

Verify installation

Security Notice

Documentation

List & Monetize Your Skill

Use Cases

Accelerate Code Development

Code Review Automation

Debug Complex Issues

Install Skill

docs-writer skill instructions

Step 1: Understand the goal and create a plan

Step 2: Investigate and gather information

Step 3: Write or edit the documentation

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

Step 4: Verify and finalize

Learn New Technologies

Implementation Guide

Best Practices

When to Use This

Learning Path

Integration

Related Skills

codenavi

create-rfc

roblox-game-development

pyqt6-ui-development-rules

react-nextjs-development

macos-development

Reviews

Discussion

`docs-writer` skill instructions