Home

Welcome to the Spectro Cloud Style Guide.

The Spectro Cloud Style Guide provides standards and guidelines for developing Spectro Cloud-related documentation in line with our brand, voice, and style. We believe in communicating effectively with all users and focus on keeping it simple, concise, and friendly.

To ensure all documentation reflects our voice and style, we recommend you start by reviewing the Style Guide. Use the Spectro Cloud Style Guide to effectively translate our preferred communication approach into impactful documentation, ensuring that your content resonates with our audience and encourages interaction.

All of our documentation is expected to follow a set of standard templates. The Content Layout resource explains each of our writing artifacts in greater detail.

The following list provides a high-level overview of the writing artifacts we use in our documentation.

• How-to Layout - A how-to’s purpose is to help the user perform a particular task correctly. Refer to the How-to Layout to use the layout and learn how to structure a how-to guide.

• Packs Layout - The Packs Layout provides an overview and guidelines for how to organize and structure a pack documentation page. Refer to the Packs Layout guide to learn more.

• Troubleshooting Layout - All Spectro Cloud troubleshooting guides are expected to have the same look and feel. The guide must also feel familiar to the reader. Therefore, all troubleshooting guides must follow the layout standard described. Refer to the Troubleshooting Layout to use the troubleshooting layout.

• Tutorial Layout - Our tutorials are written and structured in a specific manner and style. Refer to the Tutorial Layout guide to learn how to structure a tutorial for Spectro Cloud documentation.

Refer to the Spectro Cloud Word List to learn more about the choices we have made when it comes to certain words and their usage in our writing.