User:Pavithraes/Sandbox/Documentation/Style guide

Overview
This page is a supplementary style guide for writing and editing technical documentation in MediaWiki and other technical spaces. It is intended to provide tips for writing clear, concise technical documentation in plain language, to highlight best practices and standards for a variety of technical documents used across projects, to share resources and knowledge about technical writing and editing in general.

"Good" technical documentation makes it easier for individuals to make technical contributions across Wikimedia projects. Whether you consider yourself a writer or not, your contributions are needed and appreciated.

English Wikipedia Manual of Style
The English Wikipedia's Manual of style covers certain topics in detail (like punctuation) and summarizes the key points of others. It can be a useful reference for anyone writing or editing technical documentation in English across Wikimedia projects when no more specific guidelines exist on the local wiki.

Additional guidelines for technical writing and editing
It is important to follow clear standards and style guidelines for writing and editing documentation, especially when many individuals contribute to it with varying levels of skills and experience. There are many style and usage rules for general writing – far too many to remember – and even more for technical writing. This page provides basic guidelines and tips to help get you started, as well as some specific information not covered in the Wikipedia Manual of Style.

Writing for technical audiences
Before you begin writing, it is important to think about the audience for your work.


 * Who do you imagine will be reading this technical documentation?
 * Where are they coming from?
 * How familiar are they with the concepts you are presenting?
 * What might they need to know in order to understand?

Once you have an understanding of your audience, you will have a better sense of what you need to convey and how to convey it.

Writing with a purpose
What purpose will your technical documentation serve? There are many reasons to write documentation. It is helpful to know why you are writing and what your goal is before you begin.


 * Is it to teach someone, like a newcomer, about a process or concept?
 * Is it to show someone how to follow a process?
 * Is it meant to provide background and context for a concept or process?
 * Is it a reference intended to provide information?

Writing within a context
When deciding what to write and how to frame it for your reader, it can help to define a context or occasion for your writing. Your communication takes place in the context of a bigger situation. The context may be bounded by the era you are writing in, the type of technology available, your geographical location and culture, or the current culture and communication styles of the community you and your readers belong to. The occasion may be personal and arise from the situation that motivated you to create or improve a piece of documentation.

For example, if you are writing technical documentation for Wikimedia projects, consider the culture created by the individuals who volunteer, and take part across them. How could you best position your writing within the context of this community and its culture to create the most meaningful and useful technical documentation?

User testing and feedback
Create technical documentation to communicate ideas and concepts to a real audience of users. Naturally, this audience should play a critical role in how the documentation is shaped and reshaped. Think about ways you can gather information about your users' experiences. Take some time to answer the following questions:
 * Does your documentation include a mechanism for feedback?
 * Can you engage in timely conversations with the audience to make improvements?

Clarity and consistency
Your goal is to make accessing, reading, and creating technical documentation for MediaWiki/Wikimedia easier and more intuitive by promoting clarity and consistency throughout. Technical documentation is written for a wide audience and edited by a variety of contributors.

Voice, tone, grammar usage, style, and format should be consistent across technical documentation and similar content collections. This helps readers learn how to navigate information and makes it easier for contributors to understand how to edit and add new information.

Deciding on a document type
Identify your main audience, purpose, and context first to decide on the type of document you will create.

Language
This section briefly mentions some topics worth exploring elsewhere in more detail. Always check your words and expressions against these criteria on Wiktionary: Wiktionary entries cover hundreds of languages, explicitly state the grammatical and lexical features of words and their declensions, provide detailed context labels (including about jargon, UK vs. USA English) and expose how translatable terms are in hundreds of other languages.

Plain English
Please remember: many visitors to these pages are not native English speakers.

For documentation written in English, Plain English works best. Clear writing is the most understandable by diverse audiences and is also easiest to translate. There are a number of good tools for checking your writing, at Tech News' Writing Guidelines on Meta-Wiki.

Tips:


 * Avoid ambiguity, jargon, and vague or complex wording.
 * Use words your audience will understand, and enough words to convey your message.
 * Define terms that may not be obvious to individuals who are new to the subject matter you are writing about.
 * Keep paragraphs and sentences short and concise.
 * Use contractions or don't. Be consistent.

Voice and tone
MediaWiki is a place where anyone can edit. Thus, it can be difficult to maintain a consistent voice and tone in the documentation.

Consider using these elements in your writing:

Point of view

 * Use second person ("You" or assumed "You") when addressing your audience.
 * Avoid first person ("I"), unless you are writing a FAQ with questions asked from the first person perspective.
 * Use an imperative mood for most documentation focused on goals or process.

Overview
All pages should include an overview section that explains:


 * 1) Purpose of the page
 * 2) Audience of the page
 * 3) Prerequisites the reader will need to know before proceeding (Ex. working knowledge of Python)
 * 4) Software or tools the reader will need to complete the processes or tasks outlined on the page (Ex. Java installed)
 * 5) Use case, case study, a practical understanding of the product, service or tool in action. (optional)

Table of contents

 * Each page should include a table of contents, so information can be accessed easily.

Titles and Headers

 * Use sentence case for headers.
 * Keep header fonts consistent throughout documentation.
 * Optional use of anchors to link sections or subsections in the same page.

Information flow
Technical documentation pages should follow a consistent pattern across content collections.

An ideal pattern for each page might be:
 * Page Title
 * Introduction/Overview
 * Header
 * Content
 * Subhead if needed
 * Content

Formatting code examples and other technical elements
Many situations call for text to be formatted in a way that distinguishes code and other technical elements from regular text.

Templates
Templates are often used on Mediawiki.org pages. Templates can help to maintain consistency and can make it easier to translate information.

Below are some common templates:


 * ApiEx for api.php request URLs
 * Api help to transclude generated API documentation
 * caution, fixtext, note, tip, todo, and warning for styles of inline highlight boxes
 * fixme, historical, notice, outdated, and update for page/section message boxes
 * class doclink, file doclink, and js doclink to link to MediaWiki core's generated documentation
 * git file to link to source code
 * for IRC link
 * Key press for, e.g. Ctrl, and button for, e.g.
 * main and see also for page/section hatnotes (a short note placed at the top of an article)
 * MW file for a box with info and links for a file in MediaWiki core
 * ptag for the top-right-of-page phabricator project tag
 * tracked for the related Phabricator task
 * RestOfVariableName for global variables
 * tag for a quick way to mention an XML-style tag in a preformatted way

Translations
All pages on mediawiki.org are candidates for translation into multiple languages. MediaWiki.org is a multilingual wiki, it uses the Translate extension to present alternative translations and manage the translation of pages.

Tips:
 * If a page has been translated, then click 'Edit source' to edit the entire page. Wrongly placed translation tag markers around section headings can confuse section editing, and VisualEditor does not understand the, , and tags.
 * Do not copy and paste existing markup. If in doubt, focus on writing a good text and let someone else handle the Translate markup.