Jump to content

Documentation/Toolkit/Tutorial review

From mediawiki.org


This checklist is a tool to help review a tutorial. It is written in Remarkup for use in a Phabricator task, not in wikitext. For more information about tutorials, see https://www.mediawiki.org/wiki/Documentation/Patterns/Tutorial.

Page: <Add link to page>

Required:

  • [] Introduction: The first section under the title should introduce the topic and audience of the page and provide a clear description of the outcome of the tutorial.
  • [] Prerequisites: The page should include a "Prerequisites" section that describes the required tools, knowledge, or other prerequisites required to complete the tutorial.
  • [] Numbered steps: Section headings should be numbered and represent a clear sequence of steps.
  • [] Working examples: Commands and examples should be tested for accuracy.}}