Documentation/Review template

This page is a guide to reviewing Wikimedia technical documentation. Technical writers and developers can use this guide to create and maintain accurate, consistent, and inclusive documentation.

Language and style
Good documentation uses language that is plain and inclusive. Before you consider the content of the page, review the language and style.

Content types
Content types create structure and consistency across documentation pages.


 * Landing page: Landing pages are links that help the reader find information. Landing pages are navigation oriented.
 * How-to guide: How-to guides are directions that take the reader through the steps required to solve a real-world problem. How-to guides are goal oriented.
 * Tutorial: Tutorials are lessons that take the reader by the hand through a series of steps to complete a project. Tutorials are learning oriented.
 * Explanation: Explanations are discussions that clarify and illuminate a particular topic. Explanations are understanding oriented.
 * Reference: References are technical descriptions of a system and how to operate it. Reference documentation is information oriented.
 * Mixed or none of the above

Review template
Who is the page for?



What information is included on the page?



How is the page linked to related pages?



What is the content type of the page?



Checklist: Landing pages


 * Audience: The page has a clear audience or set of audiences, which is clear in the first few sentences of the page.
 * Purpose: The page has a clear purpose, which is clear in the first few sentences of the page. The contents of the page is appropriate for its purpose.
 * Topic overview: The page has a description of the topic or theme under an "About ..." section. For example: "About Wikimedia Cloud Services"
 * Managed choice: Navigation options are presented in groups of no more than six.
 * Layout: Links are organized with boxes, columns, or another link hub pattern.
 * Image: If possible, the page includes a image (not a photograph) relevant to the topic, either aligned opposite the title (right-aligned in LTR languages) using  or centered.
 * Descriptive title: The title of the page make sense when viewed directly from a search engine.
 * Status: No draft or outdated banners are present
 * Feedback: The page prompts readers to share feedback.

Development guidelines, mediawiki.org
Who is the page for?


 * Developers working on MediaWiki code, developers working on Wikimedia-related code

What information is included on the page?


 * Differences between policies, guidelines, and code conventions
 * Links to policies, guidelines, code conventions, "API client code", and "Drafts"

How is the page linked to related pages?


 * Template:Development guidelines navigation provides a list of links on the landing page and a navbox on related pages
 * Development policies and the Development policy landing page use Template:Development policy
 * Manual:Coding conventions landing page
 * Manual:Coding conventions landing page

What is the content type of the page?


 * Landing page

Help:Cloud Services Introduction, Wikitech
Who is the page for?


 * Wikimedia and affiliate staff
 * Tool developers
 * Data consumers

What information is included on the page?


 * What is Wikimedia Cloud Services
 * Links and descriptions for Cloud VPS, Toolforge, and Data Services
 * How to sign up
 * Terms and conditions

How is the page linked to related pages?


 * Links in the content
 * Category:Cloud Services

What is the content type of the page?


 * Landing page