User Tools
style_guidelines
Differences
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:36] – [Text Content Guidelines] -clarity, formatting hogwild | style_guidelines [2023/05/22 18:41] – [Text Content Guidelines] -formatting-add spacing beteween text content guidelines bullets hogwild | ||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== Wiki Editing Rights ===== | ===== Wiki Editing Rights ===== | ||
| - | To be able to edit the Wiki, you will need to get new user credentials. To request access, please send a personal message to user " | + | To be able to edit the Wiki, you will need to get new user credentials. To request access, please send a personal message to user "@rs232" on the [[https:// |
| ===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
| - | * Some wiki readers are not fluent in English. Please, choose your words carefully. | + | * Some wiki readers are not fluent in English. Please, choose your words carefully. |
| - | * Avoid abbreviations that aren't standard across the industry or in common English. | + | * Avoid abbreviations that aren't standard across the industry or in common English. |
| - | * Avoid the word " | + | * Avoid the word " |
| - | * Avoid underlining. It's obsolete and inappropriate. Research shows it also makes things harder to read. | + | * Avoid 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 which types of text are capitalized and which are written in lower case. \\ |
| - | * Please use a spell checker. Firefox' | + | * Please use a spell checker. Firefox' |
| - | * When referring to FreshTomato menus, please indicate as: // | + | * When referring to FreshTomato menus, please indicate as: // |
| - | * 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 33: | Line 33: | ||
| \\ {{: | \\ {{: | ||
| - | * Avoid using quotation marks. They are rarely appropriate, | + | * Avoid 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. | ||
style_guidelines.txt · Last modified: 2023/07/16 18:10 by hogwild
Page Tools
