---
name: Doc Writer
slug: doc-writer
category: Writing
description: Doc Writer generates README files, API docs, and user guides for code and projects. Use it when documenting code, explaining how a module works, or writing instructions for end users or developers.
github: "https://github.com/Qiao-920/claude-desktop-cn/tree/main/electron/skills/doc-writer"
language: TypeScript
stars: 259
forks: 35
install: "npx degit https://github.com/Qiao-920/claude-desktop-cn/tree/main/electron/skills/doc-writer ~/.claude/skills/doc-writer"
installs_to: ~/.claude/skills/doc-writer
source_path: electron/skills/doc-writer/SKILL.md
collection_size: 6
category_size: 1060
collection_url: "https://dirskills.com/collections/Qiao-920/claude-desktop-cn"
added: 2026-09-02T05:20:25.951Z
last_synced: 2026-09-02T05:20:25.951Z
canonical_url: "https://dirskills.com/skills/doc-writer"
---

# Doc Writer

Doc Writer generates README files, API docs, and user guides for code and projects. Use it when documenting code, explaining how a module works, or writing instructions for end users or developers.

**Install:**

```bash
npx degit https://github.com/Qiao-920/claude-desktop-cn/tree/main/electron/skills/doc-writer ~/.claude/skills/doc-writer
```

## README

# Doc Writer: Generate Documentation

Create clear, well-structured documentation for the specified code, project, or topic.

## Process

### Step 1: Understand the Target

- If a file/project path is given, read the code first using Read/Glob tools
- Identify the audience (developers, end users, API consumers)
- Understand the scope (single function, module, full project)

### Step 2: Generate Documentation

Choose the appropriate format:

**For a Project (README)**
- Project name and one-line description
- Features list
- Quick start / installation instructions
- Usage examples with code blocks
- Configuration options (if any)
- License info

**For an API / Module**
- Overview of what it does
- Function/method signatures with parameter descriptions
- Return values and error cases
- Usage examples for common scenarios
- Edge cases or important notes

**For a User Guide**
- Step-by-step instructions
- Common workflows
- FAQ / troubleshooting section

### Writing Style

- Lead with the most important information
- Use code examples liberally — show, don't just tell
- Keep sentences short and scannable
- Use tables for parameter/option lists
- Use admonitions (Note, Warning, Tip) sparingly but effectively
- Write in the user's language (match their input language)