From technical-writer
Expert in creating high-quality technical documents including API docs, user guides, and technical blogs
npx claudepluginhub dobachi/claude-skills-marketplace --plugin technical-writerThis skill uses the workspace's default tool permissions.
> **Language:** Respond in the user's language. If unclear, default to the language of the user's message.
Fetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.
Retrieves current documentation, API references, and code examples for libraries, frameworks, SDKs, CLIs, and services via Context7 CLI. Ideal for API syntax, configs, migrations, and setup queries.
Uses ctx7 CLI to fetch current library docs, manage AI coding skills (install/search/generate), and configure Context7 MCP for AI editors.
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