User:Pavithraes/Sandbox/Documentation/Style guide
 | This page has been merged to Documentation/Style guide |
Overview
[edit]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
[edit]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
[edit]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.
Audience and content
[edit]Writing for technical audiences
[edit]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.
- If you know your audience is highly technical and familiar with the processes you are describing, then you do not need to explain basic concepts.
- If you know your audience is learning or unfamiliar with the processes you are describing, then include explanations of basic concepts and links to additional information.
Writing with a purpose
[edit]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
[edit]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
[edit]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
[edit]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
[edit]
Identify your main audience, purpose, and context first to decide on the type of document you will create.
| Example Audience | Purpose[1] | Potential Document Types | Example |
|---|---|---|---|
| Newcomer interested in learning how to become a Toolforge user | To learn | Tutorial, FAQ, Getting Started guide | Cloud VPS and Toolforge FAQ |
| Experienced technical contributor trying to work through a known problem | To achieve a goal | Walk-through, How-To guide | My First Flask OAuth Tool |
| Individual trying to understand the history of ORES and how it evolved | To understand | Explanatory article, blog post | Artificial intelligence service “ORES” gives Wikipedians X-ray specs to see through bad edits |
| A person looking for a definition of SSH keys | To inform | Reference guide, glossary | Glossary |
Language
[edit]
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
[edit]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
[edit]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:
| Voice and tone | What this means | Instead of this | Try This |
|---|---|---|---|
| Friendly | Technical documentation does not need to sound academic or dry. Write to your audience as if they are there in person. | Before beginning, the user must create an account. | Start by creating an account. |
| Professional | Technical documentation can be friendly, but should remain professional. | Don't make a bazillion changes. | Try to make minimum changes. |
| Positive | Avoid using negative sentence constructions. Explain things in terms of what to do. It is harder to mentally parse a complex negative sentence! | N won't happen, if you don't XYZ. | To make N happen, do XYZ. |
| Active | Try to use active voice, except when diplomacy calls for passive voice. | The extension must be registered. | You must register the extension. |
| Non-gendered | Adopt gender-inclusive language. Assume your audience comprises all gender identities. | When he clicks Save | When the user clicks Save |
| Inclusive | Use alternatives to common words or phrases that may unintentionally reinforce inappropriate stereotypes. | This UI is crazy. | This UI could be improved. |
| Free of colloquialisms | It can be confusing to use colloquialisms, jokes, puns, or turns of phrase that non-native English speakers or individuals from other regions might not easily understand. | Creating a user account is a piece of cake. | It is easy to create a user account. |
Point of view
[edit]- 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.
Structuring pages
[edit]Overview
[edit]All pages should include an overview section that explains:
- Purpose of the page
- Audience of the page
- Prerequisites the reader will need to know before proceeding (Ex. working knowledge of Python)
- Software or tools the reader will need to complete the processes or tasks outlined on the page (Ex. Java installed)
- Use case, case study, a practical understanding of the product, service or tool in action. (optional)
Table of contents
[edit]- Each page should include a table of contents, so information can be accessed easily.
Titles and Headers
[edit]- 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
[edit]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
- Subhead if needed
- Content
Formatting text
[edit]Formatting code examples and other technical elements
[edit]Many situations call for text to be formatted in a way that distinguishes code and other technical elements from regular text.
| Purpose | Wiki-Markup | Result | Situation |
|---|---|---|---|
| Code | <code>code</code>
|
code
|
Use for short strings of code, including wikitext markup.
Within |
| Syntax highlight |
<syntaxhighlight lang="css">
.citation {
margin: 0;
}
</syntaxhighlight>
Text before |
.citation {
margin: 0;
}
Text before |
Use the <source lang="...">...</source> tag to document a few lines of code, and preserve whitespace and linebreaks. The inline attribute allows using it within an existing paragraph.
Note you cannot use italic in the middle of a See Extension:SyntaxHighlight for more details. |
| Preformatted | <pre>preformatted text
with indent |
preformatted text
with indent
|
Same as above (preserve whitespace and linebreaks), but without coloring. |
| Keyboard input | <kbd>keyboard 123</kbd> (vs keyboard 123)
|
keyboard 123 (vs keyboard 123) | Use <kbd>...</kbd> for actual keyboard input - the text a user types into an input field or at a terminal command line. It displays in plain monospace.
|
| Variables | <var>variable</var>
|
variable
italics |
Use italics for variables like message-key-name and sample names like My page title.
Do not use punctuation such as <YOURPASSWORD>, because readers don't know the angle brackets are noise and will type them. |
| Bold | '''bold'''
|
bold | Generally only used for the first instance of the page-title, and for rare emphasis of keywords to enable easier skimming of lists or paragraphs.
Note: Sometimes bold is overused for emphasis. You may consider using a template instead, e.g. {{Caution}}, {{Note}}, or {{Warning}}. |
| Quotations | "quotation marks"
Text before
Text after |
"quotation marks"
Text beforeText after |
Use quotation marks for brief pieces of content quoted from other sources.
Use blockquote for longer pieces of content. |
| Abbreviations | JavaScript (JS)
|
JavaScript (JS)
JS |
You should define abbreviations the first time they are used. Use either plain text and parentheses, or the HTML abbr tag. |
| Keypress | {{Key press}}
|
Ctrl+⇧ Shift+I | Showing specific keyboard presses or combinations. Extensive examples in VisualEditor/Portal/Keyboard shortcuts.
Note: This template might not exist on other wikis. |
| Button | {{Button}}
|
Show preview | Showing UI buttons that need to be clicked on.
Note: This template might not exist on other wikis. |
Links
[edit]| Type | Purpose | How to implement | Example |
|---|---|---|---|
| Local | Link to other MediaWiki pages |
|
MediaWiki |
| Translated Target | Link to other translated MediaWiki pages | [[Special:MyLanguage/Foo|Foo]]
|
How to contribute |
| Interwiki | Link to page belonging to a different Wikimedia project |
|
Documentation page on Wikipedia |
| External | Link to external pages | [https://www.example.org Example.org]
|
Example |
Templates
[edit]
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
- {{irc|wikimedia-tech}} for IRC link
- {{Key press}} for, e.g. Ctrl+⇧ Shift+I, and {{Button}} for, e.g. Show preview
- {{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
- {{Wg}} for global variables
- {{Tag}} for a quick way to mention an XML-style tag in a preformatted way
Translations
[edit]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 As of July 2015 VisualEditor does not understand the <languages>, <translate>, and <tvar> 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.
See also
[edit]- Wikiversity:Technical writing
- Technical writer guide
- Technical documentation prioritization
- Web APIs hub/Contributing – guide to writing articles for third-party developers
- Some other technical documentation style guides: