doc-generator
Generate or remediate documentation with human-quality writing and style
Install via CLI (Recommended)
clawhub install openclaw/skills/skills/athola/nm-scribe-doc-generatorNight Market Skill — ported from claude-night-market/scribe. For the full experience with agents, hooks, and commands, install the Claude Code plugin.
Documentation Generator
Documentation must be grounded in specific claims rather than abstract adjectives. We avoid filler phrases like "In today's fast-paced world" and focus on delivering useful information directly. Each claim should be supported by evidence, such as specific version numbers or request rates, rather than vague descriptors like "comprehensive."
Core Writing Principles
We prioritize authorial perspective and active voice to maintain a consistent team tone. This involves explaining the reasoning behind technical choices, such as selecting one database over another, rather than providing neutral boilerplate. Bullets should be used sparingly for actionable summaries; multi-line bullet waterfalls should be converted to short paragraphs to preserve nuance.
Vocabulary and Style
Avoid business jargon and linguistic tics like mirrored sentence structures or excessive em dashes. We use the imperative mood for docstrings (e.g., "Validate input") and strictly avoid humanizing non-living constructs like code.
| 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 identifieddoc-generator:style-loaded- Style profile applied (if available)doc-generator:content-drafted- Initial content createddoc-generator:slop-scanned- AI markers checkeddoc-generator:quality-verified- Principles checklist passeddoc-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]
**Length target**: [~X words or sections]
**Style profile**: [profile name or "default"]
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
Follow the 10 core principles above. For each section:
- Start with the essential information
- Add context only if it adds value
- Use specific examples
- Prefer prose over bullets
- End when information is complete (no summary padding)
Step 4: Run Slop Detector
Skill(scribe:slop-detector)
Fix any findings before proceeding.
Step 5: Quality Gate
Metadata
Not sure this is the right skill?
Describe what you want to build — we'll match you to the best skill from 16,000+ options.
Find the right skillPaste this into your clawhub.json to enable this plugin.
{
"plugins": {
"official-athola-nm-scribe-doc-generator": {
"enabled": true,
"auto_update": true
}
}
}Related Skills
extract
Analyze a codebase and build a knowledge base of business logic, architecture, data flow, and engineering patterns. The foundation for gauntlet challenges and agent integration
discourse
>- Scan community discussion channels (HN, Lobsters, Reddit, tech blogs) for experience reports and opinions on a topic
synthesize
>- Merge, deduplicate, rank, and format research findings from multiple channels into a coherent report. Use after research agents return their results
workflow-monitor
Detect workflow failures and inefficient patterns, then create GitHub issues for improvement via /fix-workflow
architecture-paradigm-hexagonal
Hexagonal (Ports and Adapters) architecture isolating domain logic from infrastructure