| name | technical-writing-patterns |
| author | JM Labs (Javier Montaño) |
| version | 1.0.0 |
| description | API docs style, tutorial structure, reference format, how-to guides. [EXPLICIT] Trigger: "technical writing patterns"
|
| allowed-tools | ["Read","Write","Glob","Grep","Bash"] |
Technical Writing Patterns
"Method over hacks."
TL;DR
API docs style, tutorial structure, reference format, how-to guides. [EXPLICIT]
Procedure
Step 1: Discover
- Gather context and requirements
Step 2: Analyze
- Evaluate options per Constitution XIII/XIV
Step 3: Execute
- Implement with evidence tags
Step 4: Validate
- Verify quality criteria met
Quality Criteria
Usage
Example invocations:
- "/technical-writing-patterns" — Run the full technical writing patterns workflow
- "technical writing patterns on this project" — Apply to current context
Assumptions & Limits
- Assumes access to project artifacts (code, docs, configs) [EXPLICIT]
- Requires English-language output unless otherwise specified [EXPLICIT]
- Does not replace domain expert judgment for final decisions [EXPLICIT]
Edge Cases
| Scenario | Handling |
|---|
| Empty or minimal input | Request clarification before proceeding |
| Conflicting requirements | Flag conflicts explicitly, propose resolution |
| Out-of-scope request | Redirect to appropriate skill or escalate |