Help:Documentation Guidelines

From Online Manual

Revision as of 03:24, 18 September 2010 by Acans (talk | contribs) (The Rules of Formal/Professional Writing)
Jump to: navigation, search

For the Online Manual we use a very particular approach to writing style, wording, etc. The Online Manual is to be written in a professional and formal way. This paragraph is neither of these. Why? Well, for starters I used "we," which is not the kind of professional or formal writing we want in our documents. Secondly, I used "etc.," which is neither professional nor formal. Thirdly, I asked a question when I said, "Why?"

Below are the guidelines all Doc Writers and Doc Helpers are asked to follow when working on SMF documentation.

The Rules of Formal/Professional Writing

This is a modified list from [1]. We have updated it to fit our needs better.

  • No Contractions - Write "it is," never "it's." Write "do not," never "don't." Under no circumstances shall you write "it'll" when you mean "it will!"
  • Passive Voice Nobody threw a ball. Instead, a ball was thrown. No chicken crossed the road; the road was crossed by the chicken.
  • No Slang or Jargon - It does not "rain cats and dogs." An iPod is not "cool" or "spiffy."
  • Never Use "I" or "You" - Be impersonal.
  • Avoid Asking Questions - People might think you're trying to be conversational.
  • No Abbreviations - You will spell out "Internal Revenue Service" at least the first time, providing the abbreviations behind it: "Internal Revenue Service (IRS)".
  • Never Use Exclamation Points - Unless you're quoting someone, maybe.
  • No Sentence Fragments - That. Would. Be. This. Sort. Of. Thing.
  • Refrain From Using Parentheses - At least, as much as possible.
  • Refrain From Using "Etc" or "So On" - See here for more information.
  • Keep It on Topic - Link elsewhere for more information.
  • Be Clear - The reader may not know anything about SMF.


Alternative Words and Phrasing


Sometimes, a word just should not be in a document. In the event that this happens, and there are a few exceptions, the list below should help you out.

WordAlternativeReasoning
ClickSelectWe select links and options, but we click the left mouse button.
FolderDirectoryProfessionalism.
You/I/WeJust don't use itFormalism and Professionalism
Get (in reference to downloading)DownloadProfessionalism.
TickCheckProfessionalism.


The above list is not exhaustive, and Doc Team members may ask you to change words not listed here.

Standard Terms


In an effort to standardize terms across our documentation, please use the following.

  • checkbox - Incorrect though it may be, it's what SMF uses.
  • drop-down list
  • login - This is another example of two words being merged into one. SMF uses it, so the documentation needs to match.
  • membergroup - These show up a lot in SMF, don't they? alt="::)" title="Roll Eyes" class="smiley" />
  • smiley
  • smileys - As much as you may want to use "smilies," don't. <img src="http://www.simplemachines.org/community/Smileys/default/wink.gif" alt=";)" title="Wink" class="smiley" />


Style Conventions


Our Online Manual has some things that are specific to it.

  • Options - Options should be in italics. That is to say if you are to select the new topic option, it should be in italics. You can quickly identify options by your urge to put them inside quotes, such as "select the "new topic" option".
  • Directions - Directions to a particular area or section should be given in the following manner: Admin > Members > Membergroups... > Add Membergroup. Notice the use of italics, spaces, and right angle brackets.
  • File Paths - For directories or files, the path should be separated by forward slashes /.


The above list is also not exhaustive.

(Sub-)Headings


As demonstrated in this topic, headings may be used within documents to separate logical sections. If a heading is used, it should not be used first. There should always be at least one paragraph of text preceding any headings in a document. To create a heading in a document, simply use [size=4]Title[/size][hr] and change "Title" to the title of the heading.

If further separation of content is necessary, sub-headings may be used. Sub-headings should always follow headings and never be used outside of them. To create a sub-heading in a document, simply use [b]Title[/b] and change "Title" to the title of the sub-heading.

Never use only one heading or sub-heading. There must always be at least two, otherwise there is no need for them at all. They should also never be bolded, italicized, underlined, colored, linked, or be in all caps or all lowercase letters.

Lists


Lists may be used normally when simply listing options or elements, however there is a specific format for using a list to define or explain items. This format is merely that of bolding the item or term and following it with a hyphen (-) and the definition or explanation. Here's an example.

  • Item 1 - Explanation of Item 1
  • Item 2 - Explanation of Item 2


Hyperlinking


Links should always be placed on corresponding words within the normal flow of a proper sentence. Never use "Click here" (or anything similar) or a raw URL when placing a link in a document. Links should never intentionally be bolded, italicized, underlined, colored, or pointed at an off-site location (unless approved by the Doc Team).