This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
style_guidelines [2023/05/22 18:14] – [Layout/Formatting Guidelines] -condense, grammar hogwild | style_guidelines [2023/05/22 18:36] – [Layout/Formatting Guidelines] 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 |
- | * Avoid using specialized | + | * Avoid abbreviations that aren't standard across the industry or in common English. |
- | * Avoid non-standard abbreviations/ | + | * Avoid the word " |
- | * Avoid using the word " | + | * 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' | * Please use a spell checker. Firefox' | ||
- | * When referring to FreshTomato' | + | * When referring to FreshTomato menus, please indicate as: //Menu///Submenu// . // For example: //"Administration///Admin access"// |
- | * Avoid using quotation marks. They' | + | * Avoid using quotation marks. They' |
* Please use rounded brackets () . Square brackets are generally not appropriate here. | * Please use rounded brackets () . Square brackets are generally not appropriate here. | ||
Line 36: | Line 35: | ||
* Avoid using quotation marks. They are rarely appropriate, | * Avoid using quotation marks. They are rarely appropriate, | ||
* Avoid underlining. It's been obsolete since the 1980s. It makes text harder to read. | * Avoid underlining. It's been obsolete since the 1980s. It makes text harder to read. | ||
- | * Avoid using the word “NOTE”. There is a section titled "< | + | * Avoid using the word “NOTE”. There is a section titled: "< |
* Unless they are in a code window, command strings should be set in the '' | * Unless they are in a code window, command strings should be set in the '' | ||
* Variables should be italicized. | * Variables should be italicized. |