FreshTomato Wiki

User Tools

Site Tools

Trace:
style_guidelines

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
style_guidelines [2023/05/22 18:14] – [Layout/Formatting Guidelines] -condense, grammar hogwildstyle_guidelines [2023/05/22 18:36] – [Text Content Guidelines] -clarity, formatting hogwild
Line 8: Line 8:
 ===== Text Content Guidelines ===== ===== Text Content Guidelines =====
  
-  * There may be wiki readers not fluent in English. Please choose your words carefully. +  * Some wiki readers are not fluent in English. Please, choose your words carefully. 
-  * Avoid using specialized abbreviations that aren't standard across the technology industry or in common English. For example, anyone unfamiliar with Linux/Unix will not know that "wl" indicates a wireless interface. Explain it, or use it only where relevant. WiFi, however, is a standard term across computing, and society in general, and is safer to use. +  * Avoid abbreviations that aren't standard across the industry or in common English.  \\ For example, anyone unfamiliar with Linux/Unix will not know that "wl" indicates a wireless interface. If it's not standard across the industry, explain it. Using "LAN", for example, is okay. It's common terminology. 
-  * Avoid non-standard abbreviations/short forms. For example, don't use "FT" for FreshTomato. Using LAN is okay, as it's common terminology. +  * Avoid the word "Note". It's overused and rarely appropriate. If the content isn't a critical warning, consider putting it in the <WikiPageName Notes> section at the bottom of the page. We are developing guidelines/standards for writing and formatting notes. 
-  * Avoid using the word "Note". It's overused and should be used only when something is unusually important. Using it constantly makes the text  lose its impact, and makes it more jarring to read. We'll develop some guidelines/standards for writing and formatting notes. +  * Avoid underlining. It's obsolete and inappropriate. Research shows it also makes things harder to read. 
-  * Avoid using underlining. It's obsolete and inappropriate. Research shows it also makes things harder to read. +  * Please view other pages to see which types of text are capitalized and which are written in lower case. 
-  * Please view other pages to see what text is capitalized and what is written in lower case (small letters). +
   * Please use a spell checker. Firefox's spellchecker works well for this.   * Please use a spell checker. Firefox's spellchecker works well for this.
-  * When referring to FreshTomato's menus, please indicate as: //Menu/Submenu . //  For example, //Administration/Admin access .// +  * When referring to FreshTomato menus, please indicate as: //Menu///Submenu// . //  For example: //"Administration///Admin access"// .// 
-  * Avoid using quotation marks. They're almost never appropriate. If you're not sure, don't use them.+  * Avoid using quotation marks. They're almost never appropriate. If you're unsure, don't use them.
   * Please use rounded brackets () . Square brackets are generally not appropriate here.   * Please use rounded brackets () . Square brackets are generally not appropriate here.
  
style_guidelines.txt · Last modified: 2023/07/16 18:10 by hogwild

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki