style_checklist.md

layout	permalink	title	nav_order
default	/checklist/	Style Checklist	6

{: .no_toc }

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

{: .text-delta } - TOC {:toc}

Developer checklist

Did you...

☑ ...use [title case for titles]({{"/dev/formatting-and-organization/#title-capitalization" | absolute_url}}) and [sentence case for headings]({{"/dev/formatting-and-organization/#heading-capitalization" | absolute_url}})?

☑ ...[make sure not to use internal product names in public-facing documentation]({{"/dev/company-terminology/#internal-vs-external-names" | absolute_url}})?

☑ ...use [second-person pronouns like you and your to address the reader]({{"/dev/grammar/#second-person-pronouns" | absolute_url}})?

☑ ...[introduce code samples]({{"/dev/formatting-and-organization/#introduce-code-samples" | absolute_url}}), [introduce procedures]({{"/dev/formatting-and-organization/#introduce-procedures" | absolute_url}}), and [include a description after each heading]({{"/dev/formatting-and-organization/#include-descriptions-after-every-heading" | absolute_url}})?

☑ ...[describe (almost) every aspect of your API or SDK]({{"/dev/apis-and-sdks/#describe-almost-everything" | absolute_url}})?

Marketer checklist

Did you...

☑ ...use [title case for titles]({{"/mktg/formatting-and-organization/#title-capitalization" | absolute_url}}) and [sentence case for headings]({{"/mktg/formatting-and-organization/#heading-capitalization" | absolute_url}})?

☑ ...use the [active voice]({{"/mktg/grammar/#active-and-passive-voice" | absolute_url}}) and [present tense]({{"/mktg/grammar/#present-tense" | absolute_url}}) whenever possible?

☑ ...use [second-person pronouns like you and your to address the reader]({{"/mktg/grammar/#second-person-pronouns" | absolute_url}})?

☑ ...[spell out Aperture Science product names in full]({{"/mktg/company-terminology/#product-names" | absolute_url}})?

☑ ...strive for an [approachable, friendly tone]({{"mktg/tone-and-content/#be-friendly" | absolute_url}})?

Technical writer checklist

Did you...

☑ ...use [title case for titles]({{"/tw/formatting-and-organization/#title-capitalization" | absolute_url}}) and [sentence case for headings]({{"/tw/formatting-and-organization/#heading-capitalization" | absolute_url}})?

☑ ...[make sure not to use internal product names in public-facing documentation]({{"/tw/company-terminology/#internal-vs-external-names" | absolute_url}})?

☑ ...use the [active voice]({{"/tw/grammar/#active-and-passive-voice" | absolute_url}}) and [present tense]({{"/tw/grammar/#present-tense" | absolute_url}}) whenever possible?

☑ ...use [second-person pronouns like you and your to address the reader]({{"/tw/grammar/#second-person-pronouns" | absolute_url}})?

☑ ...[introduce code samples]({{"/tw/formatting-and-organization/#introduce-code-samples" | absolute_url}}), [introduce procedures]({{"/tw/formatting-and-organization/#introduce-procedures" | absolute_url}}), and [include a description after each heading]({{"/tw/formatting-and-organization/#include-descriptions-after-every-heading" | absolute_url}})?

☑ ...[put captions after their associated image]({{"/tw/formatting-and-organization/#captions" | absolute_url}})?

☑ ...[put the names of UI elements that the reader must interact with in bold]({{"/tw/user-interfaces/#bold-ui-elements" | absolute_url}})?

☑ ...[write task-oriented instructions]({{"/tw/user-interfaces/#task-oriented-instructions" | absolute_url}})?

☑ ...[use descriptive link text]({{"/tw/formatting-and-organization/#descriptive-link-text" | absolute_url}})?