Here is a list of popular documentation style guides that are widely used across various fields and industries:
### Technical Writing Style Guides
1. **Microsoft Manual of Style**
- Focus: Guidelines for technical writing, especially for software and IT documentation.
- Usage: Commonly used by software developers, technical writers, and IT professionals.
Official Resource:Microsoft Writing Style Guide: This is the updated online version of the Microsoft Manual of Style, which provides guidelines for writing and developing content.Microsoft Writing Style Guide
Books:Microsoft Manual of Style for Technical Publications: This book provides comprehensive guidelines for technical documentation.Amazon
2. **Google Developer Documentation Style Guide**
- Focus: Best practices for writing clear and concise documentation for Google products and open source projects.
- Usage: Ideal for developers and technical writers involved in creating developer-focused content.
Official Resource:Google Developer Documentation Style Guide: This is an online guide that provides best practices for creating clear and concise documentation for Google products.
Courses and Tutorials:Technical Writing One and Two: Google offers free online courses that cover the fundamentals of technical writing, including principles from the Google Developer Documentation Style Guide.
3. **Apple Style Guide**
- Focus: Consistent terminology, style, and tone for Apple-related documentation.
- Usage: Used by technical writers and developers working on Apple products.
Official Resource:Apple Style Guide: This guide provides the standards for terminology, style, and usage in Apple-related documentation.Apple Style Guide
Developer Documentation:Apple Developer Documentation: This resource includes the Apple Style Guide along with other guidelines for developing and documenting Apple products.Apple Developer Documentation
4. **IBM Style Guide**
- Focus: Standards for writing and designing technical content, particularly for IBM products.
- Usage: Commonly used by IBM employees and partners.
5. **Microsoft Writing Style Guide**
- Focus: Guidelines for Microsoft product content, including web content and user interfaces.
- Usage: Widely adopted by technical writers and content creators working with Microsoft products.
6. **Read the Docs Style Guide**
- Focus: Best practices for writing documentation that will be published using the Read the Docs platform.
- Usage: Useful for open-source projects and technical writers using Sphinx or MkDocs.
### General Writing Style Guides
1. **The Chicago Manual of Style**
- Focus: Comprehensive guide covering various aspects of writing, including grammar, punctuation, and citation.
- Usage: Used by writers, editors, and publishers across different fields.
2. **The Associated Press (AP) Stylebook**
- Focus: Guidelines for news writing, including grammar, punctuation, and journalistic standards.
- Usage: Widely used by journalists, PR professionals, and communication specialists.
3. **Modern Language Association (MLA) Handbook**
- Focus: Guidelines for writing and citing sources in the humanities.
- Usage: Commonly used by students, researchers, and academics in literature and language studies.
4. **American Psychological Association (APA) Style Guide**
- Focus: Standards for writing and citing sources in the social sciences.
- Usage: Frequently used by students, researchers, and professionals in psychology, sociology, and other social sciences.
5. **The Elements of Style by Strunk and White**
- Focus: Concise and practical advice on grammar, usage, and style.
- Usage: Popular among writers, editors, and students for its straightforward guidance.
6. **The Yahoo! Style Guide**
- Focus: Best practices for writing web content, including SEO, accessibility, and readability.
- Usage: Useful for content creators, web developers, and digital marketers.
Each of these style guides offers valuable guidelines and best practices for creating clear, consistent, and professional documentation. Selecting the appropriate style guide depends on the specific needs of your project and the industry standards you need to follow.
留言
張貼留言