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 [2022/02/03 17:00] – [Layout/Formatting Guidelines] -changed quotes usage to new bullet point hogwild | style_guidelines [2022/02/23 00:22] – "many" - vague,undefined,unsubstantiated statment djk44883 | ||
---|---|---|---|
Line 8: | Line 8: | ||
===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
- | * Many wiki readers | + | * There may be wiki readers |
* 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 " | * 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 " | ||
* Avoid non-standard abbreviations/ | * Avoid non-standard abbreviations/ | ||
Line 35: | Line 35: | ||
* Avoid using quotation marks except where absolutely appropriate. | * Avoid using quotation marks except where absolutely appropriate. | ||
* They are rarely appropriate, | * They are rarely appropriate, | ||
- | * Avoid underlining. It has been considered obsolete since the 1980s. | + | * Avoid underlining. It has been considered 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 '' |