Style Checklist
Stop! Before you publish what you’ve written, have you checked to make sure that your draft meets the “minimum viable docs” style guidelines?
Table of contents
Developer checklist
Did you…
☑ …use title case for titles and sentence case for headings?
☑ …make sure not to use internal product names in public-facing documentation?
☑ …use second-person pronouns like you and your to address the reader?
☑ …introduce code samples, introduce procedures, and include a description after each heading?
☑ …describe (almost) every aspect of your API or SDK?
Marketer checklist
Did you…
☑ …use title case for titles and sentence case for headings?
☑ …use the active voice and present tense whenever possible?
☑ …use second-person pronouns like you and your to address the reader?
☑ …spell out Aperture Science product names in full?
☑ …strive for an approachable, friendly tone?
Technical writer checklist
Did you…
☑ …use title case for titles and sentence case for headings?
☑ …make sure not to use internal product names in public-facing documentation?
☑ …use the active voice and present tense whenever possible?
☑ …use second-person pronouns like you and your to address the reader?
☑ …introduce code samples, introduce procedures, and include a description after each heading?
☑ …put captions after their associated image?
☑ …put the names of UI elements that the reader must interact with in bold?