Showing UI buttons that need to be clicked on. Note: This template might not exist on other wikis. Extensive examples in VisualEditor/Portal/Keyboard shortcuts. Showing specific keyboard presses or combinations. Use either plain text and parentheses, or the HTML abbr tag. You should define abbreviations the first time they are used. Use blockquote for longer pieces of content. A link that specifies a section of a redirect page corresponds to a link to that section of the target of the redirect. Use quotation marks for brief pieces of content quoted from other sources. You may consider using a template instead, e.g. Note: Sometimes bold is overused for emphasis. 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. The page will be automatically named with the name of the link. A link to a non-existent page is colored in red: When you click on such a link the form for adding the content and creating the page will open. 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.Ĭreating a user account is a piece of cake.Ĭreating a user account requires two steps. To add a link on an existing page, simply edit that page and use the button at the top of the text editor for inserting an internal link. Use alternatives to common words or phrases that may unintentionally reinforce inappropriate stereotypes.Īvoid terms like "easy" and "simple" which can be frustrating for less tech-savvy users. Put the link target first, then the pipe character '', then the link text. You can make a link point to a different place with a piped link. Example section 3 goes to the third section named 'Example section'. Assume your audience comprises all gender identities. If multiple sections have the same title, add a number. Try to use active voice, except when diplomacy calls for passive voice.Īdopt gender-inclusive language. It is harder to mentally parse a complex negative sentence! Īvoid using negative sentence constructions. Technical documentation can be friendly, but should remain professional. Write to your audience as if they are there in person.īefore beginning, the user must create an account. All HTML in the headings is stripped in the TOC, except the. Typically, the table reproduces and numbers these headings. By default, a table of contents (sometimes abbreviated to TOC) is automatically generated on a page when more than three section headings are used. Technical documentation does not need to sound academic or dry. For the contents page of the MediaWiki technical manual, see Manual:Contents.
Consider using these elements in your writing:
0 kommentar(er)
