Documentation Generator

A document costs the sum of its readers’ time. Earn that cost or cut.

Generate documents that are grounded in specific claims, lead with their thesis, and earn every sentence. Filler phrases like “In today’s fast-paced world” and vague descriptors like “thorough” or “complete” without evidence are bloat. So is any sentence that does not carry, instance, bound, or repeat the document’s one takeaway.

This skill enforces both sentence-level cleanliness (no slop vocabulary, em dash overuse, or sycophantic openers) and document-level economy (thesis-first, every sentence earns weight, repetition reserved for the thesis). See Skill(scribe:slop-detector) module document-economy.md for the full rubric.

Core Writing Principles

Use active voice and an authorial perspective. Explain the reasoning behind technical choices (why this database, not that one) rather than presenting neutral boilerplate. Use bullets sparingly for short, parallel summaries; convert multi-line bullet waterfalls into prose so the reasoning survives.

Vocabulary and Style

Avoid business jargon and linguistic tics like mirrored sentence structures or em dash overuse. Use the imperative mood for docstrings (“Validate input”, not “Validates”). Do not humanize non-living constructs (“the code wants”, “the function speaks to”).

Instead of	Use
fallback	default, secondary
leverage	use
utilize	use
facilitate	help, enable
comprehensive	thorough, complete

9. Limit Humanizing Constructs

“Lives under,” “speaks to,” and similar phrases only make sense for living things.

10. Imperative Mood for Docstrings

“Validate” not “Validates” (per PEP 257, pydocstyle, ruff).

Required TodoWrite Items

doc-generator:scope-defined - Target files and type identified
doc-generator:style-loaded - Style profile applied (if available)
doc-generator:content-drafted - Initial content created
doc-generator:slop-scanned - AI markers checked
doc-generator:quality-verified - Principles checklist passed
doc-generator:user-approved - Final approval received

Mode: Generation

For new documentation:

Step 1: Define Scope

## Generation Request

**Type**: [README/Guide/API docs/Tutorial]
**Audience**: [developers/users/admins]
**Audience size**: [1 / small team / org / public]
**Read frequency**: [once / weekly / per-invocation]
**Thesis**: [one sentence the reader must walk away with]
**Length target**: [~X words or sections]
**Style profile**: [profile name or "default"]

The Thesis field is required. If you cannot state the takeaway in one sentence, the scope is not ready. Audience size and read frequency feed the reader-time budget (see scribe:slop-detector module document-economy.md): a skill loaded daily by 50 users has a wildly different budget than a 1:1 design note.

Step 2: Load Style (if available)

If a style profile exists:

cat .scribe/style-profile.yaml

Apply voice, vocabulary, and structural guidelines.

Step 3: Draft Content

Lead with the thesis. The first paragraph must state the single takeaway. If a reader stops after the lead, they should still leave with the message. Echo the thesis once in the body and once at the close; cut every other repetition.

Follow the 10 core principles above. For each section:

Start with the essential information (state the thesis or a clear instance of it)
Add context only if it adds value (does it carry, instance, or bound the thesis?)
Use specific examples (one is proof; two is emphasis; three is filler)
Prefer prose over bullets
End when information is complete (no summary padding, no “in conclusion” restatements)

Step 4: Run Slop Detector

Skill(scribe:slop-detector)

Fix any findings before proceeding.

Step 5: Quality Gate

Verify against checklist:

Sentence-level:

No tier-1 slop words
Em dash count < 3 per 1000 words
Bullet ratio < 40%
All claims grounded with specifics
No formulaic openers or closers
Authorial perspective present
No emojis (unless explicitly requested)

Document-level (document-economy module):

Thesis stated in the lead, single and clear (2/2)
>80% of sentences carry, instance, bound, or repeat the thesis (2/2)
Thesis echoed at least 3 times; non-thesis repetition cut (2/2)
Writing time roughly proportional to (audience size × read frequency × per-read time)

Mode: Remediation

For cleaning up existing content:

Load: @modules/remediation-workflow.md

Step 1: Analyze Current State

# Get slop score
Skill(scribe:slop-detector) --target file.md

Step 2: Section-by-Section Approach

For large files (>200 lines), edit incrementally:

## Section: [Name] (Lines X-Y)

**Current slop score**: X.X
**Issues found**: [list]

**Proposed changes**:
1. [Change 1]
2. [Change 2]

**Before**:
> [current text]

**After**:
> [proposed text]

Proceed? [Y/n/edit]

Step 3: Preserve Intent

Never change WHAT is said, only HOW. If meaning is unclear, ask.

Step 4: Re-verify

After edits, re-run slop-detector to confirm improvement.

Docstring-Specific Rules

When editing code comments:

ONLY modify docstring/comment text
Never change surrounding code
Use imperative mood (“Validate input” not “Validates input”)
Brief is better - remove filler
Keep Args/Returns structure if present

Module Reference

See modules/generation-guidelines.md for content creation patterns
See modules/quality-gates.md for validation criteria

Integration with Other Skills

Skill	When to Use
slop-detector	After drafting, before approval
style-learner	Before generation to load profile
sanctum:doc-updates	For broader doc maintenance

Exit Criteria

Content created or remediated
Slop score < 1.5 (clean rating)
Quality gate checklist passed
User approval received
No emojis present (unless specified)

doc-generator

快捷安装