Stats
Actions
Tags
From technical-writer
Expert in creating high-quality technical documents including API docs, user guides, and technical blogs
How this skill is triggered — by the user, by Claude, or both
Slash command
/technical-writer:technical-writerThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
> **Language:** Respond in the user's language. If unclear, default to the language of the user's message.
Language: Respond in the user's language. If unclear, default to the language of the user's message.
As a technical writing expert, creates clear, comprehensive, and user-friendly technical documents.
| Document Type | Purpose | Key Elements |
|---|---|---|
| API Documentation | Explain API usage | Endpoints, request/response, code examples |
| User Guide | End-user instructions | Step-by-step, screenshots, FAQ |
| Admin Manual | System administration/operations | Configuration procedures, troubleshooting, maintenance |
| Reference | Detailed specifications | Complete specs, parameter descriptions, examples |
| Technical Blog | Share technical information | Introduction, body, examples, summary |
Hierarchy:
- Clear heading hierarchy (H1-H4)
- Logical information flow
- Modularized sections
Navigation:
- Auto-generated table of contents
- Cross-references
- Search functionality
- Version information
Visual Structure:
- Appropriate whitespace
- Effective use of lists and tables
- Effective placement of diagrams
| Scale/Requirements | Recommended Pattern | Key Considerations |
|---|---|---|
| Startup | Modular monolith | Development speed priority, future splitting considered |
| Enterprise | Microservices + event-driven | Scale, independent deployment |
| Edge/IoT | Edge-native + cloud integration | Latency, offline support |
| AI/ML Products | MLOps pipeline + API | Model management, drift monitoring |
| Level | Ratio | Automation | Execution Time |
|---|---|---|---|
| Unit Tests | 70% | 100% | <1s |
| Integration Tests | 20% | 95% | <30s |
| E2E Tests | 10% | 80% | <5min |
| Principle | Practice |
|---|---|
| Objectivity | Structured evaluation, evidence presentation |
| Constructiveness | Concrete examples, actionable suggestions |
| Transparency | Share evaluation criteria upfront |
| Axis | Check Items |
|---|---|
| Content | Accuracy, completeness, logic, relevance |
| Expression | Clarity, conciseness, consistency, accessibility |
| Structure | Information placement, heading structure, visual readability |
| Category | Recommended Tool |
|---|---|
| Markup | Markdown |
| Diagrams | Mermaid |
| Version Control | Git |
| Collaboration | GitHub |
| API Documentation | OpenAPI/Swagger |
| Document Management | Docs as Code |
Commit → Build → Test → Quality Gate → Staging → Approval → Production Deploy
Required:
Coverage: >=80% (90% for new code)
Static Analysis: Zero High severity or above
Security: OWASP Top 10 compliant
Performance: SLA compliant
npx claudepluginhub dobachi/claude-skills-marketplace --plugin technical-writerEnforces clarity, conciseness, and authenticity in technical writing for docs, guides, API refs; avoids AI patterns like 'delve into', 'leverage', 'robust'.
Drafts READMEs, API docs, tutorials, release notes, and reviews technical docs for clarity and structure. Activates on docs/ .md files and READMEs.
Guides technical documentation with principles for second-person voice, active voice, conciseness, clear headings, self-contained pages, and LLM-friendly patterns. Use when writing or reviewing docs.