This skill should be used when writing or reviewing technical documentation such as READMEs, API documentation, quickstart guides, or any user-facing documentation. Apply editorial principles focused on leading with value, cutting redundancy, and creating scannable, actionable content. Use when the user requests help writing docs, improving existing documentation, or creating user guides.
Apply proven editorial principles to create clear, concise, and effective technical documentation. This skill emphasizes leading with user value, ruthlessly cutting redundancy, and creating scannable content that respects reader intelligence.
Apply these five foundational principles when writing or reviewing documentation:
Begin with what users can achieve, not how the software achieves it. Implementation details belong in architecture docs, not in overview sections.
Pattern:
Use "Enable", "Manage", "Control" instead of "Discovers", "Scans", "Processes". Shift focus from what the tool does to what users can do with it.
Pattern:
.claude/skills/ folders"Remove:
Trust reader intelligence. Every sentence must add new information.
Present the recommended approach. Listing multiple options creates decision paralysis. If alternatives exist, mention them in an options section, not inline.
Pattern:
--interactive and -i flags-i (the recommended short form)Use single, consolidated code blocks with inline comments instead of multiple scattered examples. This improves scannability and copy-paste usability.
Choose the appropriate structure based on content type:
README.md - Apply strict adherence to principles:
API Documentation - Precision over brevity:
Troubleshooting Guides - Hand-holding is acceptable:
sh, bash, python)Follow this structure for documenting commands:
### `command-name`
[Purpose statement in one sentence]
Options:
- `--flag`: Description of what flag does.
- `--another`: Description of another flag.
Examples:
```bash
command-name
command-name --flag
command-name --flag --another --verbose
Order examples from simple to complex.
## Opening Section Pattern
Structure opening sections as:
1. One-sentence value proposition
2. One-sentence mechanism explanation
Example:
```markdown
Skillz is a CLI that enables skills across any LLM powered tool in a matter of seconds.
It works by injecting skill instructions in the `AGENTS.md` instruction file.
Use this pattern: Action verb + benefit + (optional technical detail)
Example:
- Enable skill usage by automatically detecting tool environment
- Enable skills to be automatically synced from well known paths
- Manage and edit skills directly from the CLI
Maintain these characteristics:
Avoid:
Before finalizing documentation, verify:
For comprehensive coverage of all principles, examples, and edge cases, consult the complete writing guide:
Load when needed: references/WRITING_GUIDE.md
This reference contains:
Use grep to search for specific topics:
When writing or reviewing documentation:
references/WRITING_GUIDE.md for detailed guidance when neededThe goal: Create documentation that gets users productive quickly while respecting their time and intelligence.
Search for places (restaurants, cafes, etc.) via Google Places API proxy on localhost.
Interact with GitHub using the `gh` CLI. Use `gh issue`, `gh pr`, `gh run`, and `gh api` for issues, PRs, CI runs, and advanced queries.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Start voice calls via the OpenClaw voice-call plugin.
Notion API for creating and managing pages, databases, and blocks.
Gemini CLI for one-shot Q&A, summaries, and generation.
Category:developer