Agent Skills
› NeverSight/learn-skills.dev
› technical-writer
technical-writer
GitHub专注于为开发者、用户及利益相关者创建清晰准确的技术文档。涵盖API参考、用户指南、教程、知识库及README等，提供从内容创作到维护的标准工作流与最佳实践。
Trigger Scenarios
编写API文档和参考指南
创建用户指南和入门教程
构建知识库和FAQ
撰写README文件
编写开发者入职文档
Install
npx skills add NeverSight/learn-skills.dev --skill technical-writer -g -y
SKILL.md
Frontmatter
{
"name": "technical-writer",
"description": "Expert in creating clear, accurate, and user-friendly documentation. Masters API documentation, user guides, tutorials, and knowledge base creation."
}
Technical Writer
Purpose
Provides expertise in creating effective technical documentation for developers, users, and stakeholders. Specializes in API documentation, user guides, tutorials, and building maintainable documentation systems that serve diverse audiences.
When to Use
- Writing API documentation and reference guides
- Creating user guides and getting-started tutorials
- Building knowledge bases and FAQs
- Writing README files and project documentation
- Creating onboarding documentation for developers
- Documenting architecture and system design
- Writing release notes and changelogs
- Standardizing documentation style across projects
Quick Start
Invoke this skill when:
- Writing API documentation and reference guides
- Creating user guides and getting-started tutorials
- Building knowledge bases and FAQs
- Writing README files and project documentation
- Creating onboarding documentation for developers
Do NOT invoke when:
- Writing code comments → developer responsibility
- Creating ADRs → use document-writer
- Writing marketing content → use content-marketer
- Designing documentation infrastructure → use documentation-engineer
Decision Framework
Documentation Type?
├── API Reference → OpenAPI spec + generated docs
├── Getting Started → Quick start guide + first success
├── Conceptual → Architecture overview + mental models
├── How-To → Task-focused step-by-step guides
├── Troubleshooting → Problem-solution format
└── Release Notes → User-focused change descriptions
Core Workflows
1. API Documentation
- Review API endpoints and data models
- Write clear endpoint descriptions with use cases
- Document request/response formats with examples
- Include authentication and error handling
- Add code samples in multiple languages
- Test all examples for accuracy
- Set up versioning for API changes
2. Tutorial Development
- Identify target audience and prerequisites
- Define learning objectives and outcomes
- Structure content in progressive complexity
- Write step-by-step instructions with context
- Add code samples that can be copied and run
- Include troubleshooting for common issues
- Test tutorial flow with fresh environment
3. Documentation Maintenance
- Establish documentation review schedule
- Set up automated checks for broken links
- Track documentation alongside code changes
- Collect and incorporate user feedback
- Update examples when APIs change
- Archive deprecated content appropriately
- Monitor analytics for improvement opportunities
Best Practices
- Write for the reader's goals, not the system's structure
- Use consistent terminology with a defined glossary
- Include working code examples that users can copy
- Test all procedures in clean environments
- Keep sentences short and paragraphs focused
- Use visuals (diagrams, screenshots) where they add clarity
Anti-Patterns
- Developer-centric writing → Focus on user tasks and goals
- Outdated examples → Automate testing of code samples
- Wall of text → Use headings, lists, and whitespace
- Assuming knowledge → State prerequisites explicitly
- One-time writing → Treat docs as living documents
Version History
- e0220ca Current 2026-07-05 21:18
