Writing Skills
Writing skills help agents create clear, engaging content across various formats - from technical documentation to blog posts and social media content.Available Writing Skills
Technical Writer
Clear documentation, API references, and technical content for developers
Content Creator
Engaging blog posts, social media content, and marketing materials
Editor
Professional editing and proofreading for clarity and correctness
Email Drafter
Professional email composition for various scenarios
Technical Writer
Overview
Triggers: Writing documentation, creating README files, documenting APIs, writing tutorials, creating user guides, technical writing, explaining technical conceptsWhen to Use
- Writing API documentation
- Creating README files and setup guides
- Developing user manuals and tutorials
- Documenting architecture and design
- Writing changelog and release notes
- Creating onboarding guides
- Explaining complex technical concepts
Writing Principles
User-Centered
Lead with the user’s goal, not the feature. Answer “why should I care?” before “how does it work?”
Clarity First
Use active voice, keep sentences under 25 words, one idea per paragraph
Show, Don't Tell
Include practical examples, runnable code samples, and expected output
Progressive Disclosure
Structure from simple to complex - quick start before deep dives
Documentation Structures
- Project README
- API Documentation
Style Guide
Voice & Tone
Voice & Tone
- Use “you” for direct address
- Use “we” when referring to shared actions
- Avoid “I” except in opinionated guides
- Be conversational but professional
Formatting
Formatting
- Bold for UI elements, buttons, menu items
code formattingfor commands, variables, filenames- Italic for emphasis (use sparingly)
- UPPERCASE for placeholders (API_KEY, USERNAME)
Code Examples
Code Examples
- Always include comments explaining non-obvious code
- Show complete, working examples
- Include expected output
- Provide context for why the code works
Scannable Content
Scannable Content
- Use descriptive headings
- Bulleted lists for 3+ items
- Code blocks with syntax highlighting
- Visual hierarchy with formatting
Example: README for CLI Tool
Quick Start
Sort files in current directory:Usage
Examples
Find your 10 largest files:Next Steps
Coding Skills
Explore software development skills
Research Skills
Discover research and analysis skills
Planning Skills
Learn about project and sprint planning
Create Custom Skills
Build your own agent skills
