Rackspace Style Guide for Technical Content#
Last updated: Jan 29, 2020
This document contains writing, style, terminology, and image guidelines for Rackspace technical documentation. Use these guidelines to create clear, concise, and consistent technical content for Rackspace external and internal customers.
- Highlights top writing and style guidelines for content contributors.
- Writing guidelines
- Provides detailed advice for writing content that is clear, active, direct, and grammatically correct. This section explains fundamental standards for good technical writing.
- Style guidelines
- Provides information about how certain elements appear in Rackspace content—for example, how we show abbreviations, how we capitalize headings, whether we allow contractions, and what formatting we apply to certain text.
- Terminology guidelines
- Provides advice for using accurate, consistent, and concise terminology in your content, and for writing for a global audience.
- Screenshot and diagram guidelines
- Provides instructions for when to use and how to create screenshots and diagrams to enhance your content.
- Control panel and portal standards
- Provides guidelines for the capitalization and the URLs used for standard control panels and portals that are referenced in our technical documentation.
- How-To article guidelines
- Provides guidelines specifically for How-To articles that are published at https://support.rackspace.com/. Use these guidelines when writing any How-To articles for this site. You can share these guidelines with outside contributors that you are working with as an Information Developer and use them as you review How-To articles written by outside contributors.
- Blog guidelines
- Provides instructions specifically for blogs for the Rackspace Developer Blog that is published at https://developer.rackspace.com/blog/. Use these guidelines when writing any developer blog for this site.
- Error message guidelines
- Provides guidelines specifically for error messages in Rackspace internal and external documentation. You can share these guidelines with development teams that you are working with as an Information Developer and use them as you review error messages written by development teams.
- Release notes guidelines
- Provides instructions specifically for writing release notes for Rackspace Cloud services APIs. You can use these basic guidelines, however, when writing release notes for any product or service.
- User interface guidelines
- Provides links to the user interface guidelines in the Helix documentation. The Helix documentation includes text conventions for user interfaces. Helix is a Rackspace-chartered effort to unify the look, feel, and functionality of Rackspace interfaces. Helix is one system composed of a design library for designers and a UI toolkit for developers.
This work is licensed under a Creative Commons Attribution 4.0 International License.