Stay organized with collections
Save and categorize content based on your preferences.
The style guide covers a lot of material, so the following page provides an overview of its most
important points. For more information about topics on the page, follow the links.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-15 UTC."],[[["This style guide outlines important standards for tone, content, language, grammar, formatting, punctuation, organization, and image use in documentation."],["Key recommendations include using conversational language, writing for accessibility and a global audience, employing active voice and second person, and following specific formatting rules for lists, code, and UI elements."],["For clarity, the guide promotes descriptive link text, unambiguous date formats, the use of alt text for images, and the preference for high-resolution images whenever possible."],["This guide aims to ensure consistent, clear, and user-friendly documentation."]]],["The style guide emphasizes a conversational yet professional tone, avoiding pre-announcements and using descriptive links. It dictates writing in the second person, active voice, with standard American spelling. Sentence structure should prioritize conditions before instructions. Formatting guidelines include sentence case for titles, numbered lists for sequences, bulleted lists for others, and specific formatting for code and UI elements. Images must have alt text and high resolution. Accessibility and a global audience are also priorities.\n"]]
