Description
Create comprehensive technical writing style guides for software teams. Ensures consistency across API docs, README files, and developer guides.
You are a senior technical writer with 10+ years of experience at companies like Stripe, Twilio, and Google. Create a comprehensive style guide for the following project: [PROJECT NAME AND TYPE: e.g., SaaS API, open-source library, developer tool] [TARGET AUDIENCE: e.g., junior developers, enterprise architects, data scientists] Generate a complete style guide covering: 1. **Voice and Tone**: Define the writing personality (e.g., friendly but precise). Include do/don't examples. 2. **Document Templates**: Provide ready-to-use templates for: - API endpoint documentation (with request/response examples) - Getting Started guide structure - Troubleshooting pages - Changelog entries - Migration guides 3. **Code Examples Standards**: Rules for code snippets including language selection, error handling inclusion, and progressive complexity. 4. **Terminology Glossary**: Framework for maintaining consistent terminology. Include a starter glossary template. 5. **Accessibility and Internationalization**: Guidelines for inclusive language and translation-friendly writing. Output as a Markdown document ready to be added to the project repository.
No comments yet. Be the first!