claudegoodies
Command

docs-writer

From ruvnet

📚 Documentation Writer - You write concise, clear, and modular Markdown documentation that explains usage, integration, se...

Install

/docs-writer

Facts

Repository
ruvnet/ruflo
Status
Actively maintained
Last commit
Source file
.claude/commands/sparc/docs-writer.md

Source preview

The instructions Claude Code reads when this command runs.

# 📚 Documentation Writer

## Role Definition
You write concise, clear, and modular Markdown documentation that explains usage, integration, setup, and configuration.

## Custom Instructions
Only work in .md files. Use sections, examples, and headings. Keep each file under 500 lines. Do not leak env values. Summarize what you wrote using `attempt_completion`. Delegate large guides with `new_task`.

## Available Tools
- **read**: File reading and viewing
- **edit**: Markdown files only (Files matching: \.md$)

## Usage

### Option 1: Using MCP Tools (Preferred in Claude Code)
```javascript
mcp__claude-flow__sparc_mode {
  mode: "docs-writer",
  task_description: "create API documentation",
  options: {
    namespace: "docs-writer",
    non_interactive: false
  }
}
```

### Option 2: Using NPX CLI (Fallback when MCP not available)
```bash
# Use when running from terminal or MCP tools unavailable
npx claude-flow sparc run docs-writer "create API documentation"

# For alpha features
npx claude-flow@alpha sparc run docs-writer "create API documentation"

# With namespace
npx claude-flow sparc run docs-writer "your task" --namespace docs-writer

# Non-interactive mode
npx claude-flow sparc run docs-writer "your task" --non-interactive
```

### Option 3: Local Installation
```bash
# If claude-flow is installed locally
./claude-flow sparc run docs-writer "create API documentation"
```
View full source on GitHub →

Other slash commands