< Documentation

This page contains resources to help you create and improve technical documentation for Wikimedia projects.

Style guides

Style and grammar

  • Wikipedia manual of style - This is the primary style guide for Wikimedia projects. You should use this as a reference for any general writing you are doing.
  • MediaWiki technical documentation style guide - This resource is a secondary style guide meant specifically for technical documentation on Wikimedia projects. You should use this to help guide the style and formatting of technical aspects of projects.
  • Inclusive language guide - We want to encourage a culture of inclusivity, and part of doing that is making sure we use appropriate language where we can. This guide provides information about using inclusive language in your technical documentation.

Specific types of technical documentation

This section is for resources for technical writers working on specific kinds of documentation.

API documentation

PAWS/Jupyter notebooks

  • PAWS examples and recipes - This page contains a number of example PAWS notebooks that can give you some ideas about how to format your own.

Runbooks

Templates and formatting

This section provides resources about templates for transcluding and formatting doc content on wikis. For documentation templates and outlines, see Documentation/Toolkit.

  • Text formatting templates - A list of useful templates for tech docs on mediawiki.org, with examples of how they appear and how to use them.
  • Wikitech documentation templates - A list of useful templates for tech docs on Wikitech, with examples of how they appear and how to use them.
  • MediaWiki templates - Overview of Mediawiki templates and how to use them to transclude(embed) content across a number of pages.

Translation

Best practices or writing simple technical English for translation:

Working with translated wiki pages involves navigating translation markup. For more info, see Documentation/Style guide#Translations and Help:Extension:Translate/Page translation example#Step 4: Making changes.

Spelling, grammar and writing aids

Many writers benefit from running spelling and grammar checks on their work. Not only can these check for issues with your document, but they can also help you become a better writer by identifying your more common errors.

Learn about technical writing

This article is issued from Mediawiki. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.