/doc-generate

name: doc-generate
description: Generate new documentation with human-quality writing.

Doc Generate

Generate new documentation with human-quality writing.

Usage

/doc-generate [type] [options]

Arguments

| Argument | Description | |----------|-------------| | `type` | Document type: readme, guide, api, tutorial, changelog |

Options

| Option | Description | |--------|-------------| | `--style` | Style profile to apply | | `--output` | Output file path | | `--context` | Additional context files to reference | | `--length` | Target length: short, medium, long |

Examples

# Generate README from codebase
/doc-generate readme

# Generate API docs with style
/doc-generate api --style project-docs --output docs/api.md

# Generate tutorial with context
/doc-generate tutorial --context src/main.py examples/

Document Types

readme

Project overview with:

• One-line description
• Installation
• Quick start
• Key features
• License

guide

User guide with:

• Introduction (brief)
• Prerequisites
• Step-by-step workflow
• Common patterns
• Troubleshooting

api

API reference with:

• Endpoint/function listing
• Parameters
• Return values
• Examples
• Error handling

tutorial

Learning-focused with:

• Goal statement
• Prerequisites
• Incremental steps
• Explanations
• Final result

changelog

Version history with:

• Version headers
• Change categories (Added, Changed, Fixed, Removed)
• Brief descriptions
• Breaking change notices

Quality Enforcement

All generated content automatically:

1. Avoids tier-1 slop words 2. Follows grounding principle (specifics over adjectives) 3. Uses appropriate sentence variation 4. Skips formulaic openers/closers 5. Runs through slop-detector in **prevention mode** before output

Prevention mode is strict. Any of the following in newly generated prose is a hard failure that must be fixed before write:

• Em-dashes (target: zero; replace with comma/colon/period/paren)
• Plus-sign as conjunction in prose ("hooks + skills")
• ASCII / Unicode arrows in prose (`->`, `→`)
• Spatial copula with inanimate subject ("lives in", "sits

at", "stands as", "rests on", "serves as", "boasts")

• Negative parallelism ("Not X but Y", "It's not X, it's Y",

"Y, not X", "No X. No Y. Just Z.", "No X, no Y, no Z", "And that's okay.")

• Throat-clearing openers ("Here's the thing,", "Look,",

"Let that sink in.")

• Three-fragment burst ("Focused. Aligned. Measurable.")
• Smart quotes outside code blocks

See `Skill(scribe:slop-detector)` § Step 4.6 for the full prevention catalog and `modules/remediation-strategies.md` § Tier 5 / 2026 for the substitution tables.

Output

Generated file with quality report:

Generated: docs/guide.md (1,245 words)

Quality Check:
- Slop score: 0.8 (clean)
- Tier 1 words: 0
- Em dashes: 2/1000
- All claims grounded: yes

File written successfully.

See Also

• `/style-learn` - Create style profile first
• `/doc-polish` - Refine generated content
• `Skill(scribe:doc-generator)` - Full generation skill