Site Tools


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 revision
Previous revision
Next revisionBoth sides next revision
style_guidelines [2022/02/03 17:00] – [Layout/Formatting Guidelines] hogwildstyle_guidelines [2022/03/09 18:32] – [Layout/Formatting Guidelines] clarity djk44883
Line 8: Line 8:
 ===== Text Content Guidelines ===== ===== Text Content Guidelines =====
  
-  * Many wiki readers aren'fluent in English. Please choose your words carefully.+  * There may be wiki readers 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 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 non-standard abbreviations/short forms. For example, don't use "FT" for FreshTomato. Using LAN is okay, as 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.
Line 23: Line 23:
  
 Following style guidelines makes pages easier to understand, more pleasant to read, and easier on the brain and eyes. Following style guidelines makes pages easier to understand, more pleasant to read, and easier on the brain and eyes.
 +
 +Focus on content.  Not everyone will use the same size monitor or resolution. It's possible users may have mobile devices or various models of laptops to access the wiki. Users may click Toggle theme changing the entire appearance from what you see.  Different browsers and accessibility come into play as well. 
  
   * Add a meaningful title for each wiki page, and format it with the Heading1 format.   * Add a meaningful title for each wiki page, and format it with the Heading1 format.
Line 41: Line 43:
   * Process/Module names should be italicized to set them off from the main text.    * Process/Module names should be italicized to set them off from the main text. 
   * Avoid using dividing lines. Better spacing, and other formatting methods work better.   * Avoid using dividing lines. Better spacing, and other formatting methods work better.
 +  * Avoid excessive unnecessary blank lines.  These just needlessly increases page length.
  
style_guidelines.txt · Last modified: 2023/07/16 18:10 by hogwild