Stay organized with collectionsSave 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 2025-04-02 UTC."],[[["\u003cp\u003eThis style guide outlines important standards for tone, content, language, grammar, formatting, punctuation, organization, and image use in documentation.\u003c/p\u003e\n"],["\u003cp\u003eKey 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.\u003c/p\u003e\n"],["\u003cp\u003eFor 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.\u003c/p\u003e\n"],["\u003cp\u003eThis guide aims to ensure consistent, clear, and user-friendly documentation.\u003c/p\u003e\n"]]],["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"],null,["# Highlights\n\nThe style guide covers a lot of material, so the following page provides an overview of its most\nimportant points. For more information about topics on the page, follow the links.\n\nTone and content\n----------------\n\n- [Be conversational and friendly](/style/tone) without being frivolous.\n- [Don't pre-announce anything](/style/future) in documentation.\n- [Use descriptive link text](/style/cross-references#descriptive-link-text).\n- [Write accessibly](/style/accessibility).\n- [Write for a global audience](/style/translation).\n\nLanguage and grammar\n--------------------\n\n- [Use second person](/style/person): \"you\" rather than \"we.\"\n- [Use active voice](/style/voice): make clear who's performing the action.\n- [Use standard American spelling](/style/spelling) and punctuation.\n- [Put conditions before instructions](/style/sentence-structure), not after.\n- [For usage and spelling of specific words, see\n the word list](/style/wordlist).\n\nFormatting, punctuation, and organization\n-----------------------------------------\n\n- [Use sentence case](/style/capitalization) for document titles and section headings.\n- [Use numbered lists](/style/lists#types-of-lists) for sequences.\n- [Use bulleted lists](/style/lists#types-of-lists) for most other lists.\n- [Use description lists](/style/lists#types-of-lists) for pairs of related pieces of data.\n- [Use serial commas](/style/commas-serial).\n- [Put code-related text in code font](/style/code-in-text).\n- [Put UI elements in bold](/style/ui-elements).\n- [Use unambiguous date formatting](/style/dates-times).\n\nImages\n------\n\n- [Provide alt\n text](/style/images#text-associated-with-images).\n- [Provide high-resolution or vector\n images](/style/images#high-resolution-images) when practical."]]
