Documentation/Toolkit/How-to guide review
< Documentation | Toolkit
This checklist is a tool to help review a how-to guide. It is written in Remarkup for use in a Phabricator task, not in wikitext. For more information about how-to guides, see https://www.mediawiki.org/wiki/Documentation/Patterns/How-to guide.
Page: <Add link to page>
Required:
- [] Introduction: The first section under the title introduces the topic and audience of the page.
- [] Section headings: Sections should be organized by task. Headings should use verb phrases where possible.
- [] Working examples: Commands and examples should be tested for accuracy.
Recommended:
- [] "How to..." title: The title of the page starts with "How to...".}}