User Tools
style_guidelines
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| style_guidelines [2025/03/08 17:31] – [Layout/Formatting Guidelines] hogwild | style_guidelines [2025/03/09 15:31] (current) – [Layout/Formatting Guidelines] -Format-add spacing at end of page hogwild | ||
|---|---|---|---|
| Line 7: | Line 7: | ||
| ===== Text Content Guidelines ===== | ===== Text Content Guidelines ===== | ||
| - | * Please **choose your words carefully**. Some wiki readers aren't fluent in English. | + | * Please **choose your words carefully**. Some wiki readers aren't fluent in English. |
| - | + | * Unless explaining complex concepts, please keep things **brief and concise. **\\ We aim to make the documentation simple and easy to read, even for beginners. | |
| - | * Unless | + | * Add a **meaningful title** to every wiki page. Format it with the Heading1 format. |
| - | * **Add a meaningful title** to every wiki page. Format it with the Heading1 format. | + | * **Avoid abbreviations not standard across the industry** or in common English. |
| - | * ** Avoid abbreviations not standard across the industry** or in common English. | + | * **Avoid **using **the word: " |
| - | * **Avoid **using **the word: " | + | * **Avoid underlining**. It's obsolete and makes things hard to read. \\ \\ |
| - | * **Avoid underlining**. It's obsolete and makes things hard to read.\\ \\ | + | |
| * Check other pages to see which kinds of text content are capitalized \\ and which are written in lower case. \\ \\ | * Check other pages to see which kinds of text content are capitalized \\ and which are written in lower case. \\ \\ | ||
| * Check spelling with your browser' | * Check spelling with your browser' | ||
| Line 26: | Line 25: | ||
| ===== Layout/ | ===== Layout/ | ||
| - | Following style guidelines makes content easier to read, and easier to understand. \\ It also reduces stress on the brain and eyes while reading. | + | Following style guidelines makes content easier to read, and easier to understand. \\ It also reduces stress on the brain and eyes while reading. |
| - | + | ||
| - | \\ | + | |
| The wiki uses [[https:// | The wiki uses [[https:// | ||
| - | It uses [[https:// | + | It uses [[https:// |
| - | + | ||
| - | \\ | + | |
| - | + | ||
| - | * **Focus on content**. | + | |
| - | + | ||
| - | \\ | + | |
| - | + | ||
| - | * **Subheadings use the Heading2** format, and subheadings below that, Heading3.\\ | + | |
| - | + | ||
| - | \\ | + | |
| + | * **Focus on content**. | ||
| + | * **Subheadings use the Heading2** format, and subheadings below that, Heading3.\\ \\ | ||
| * **When taking screenshots**, | * **When taking screenshots**, | ||
| * For screenshots of just one or few settings options under one section, use syntax: \\ ''" | * For screenshots of just one or few settings options under one section, use syntax: \\ ''" | ||
| - | * Please save screenshots in .png format. Lossy formats are blurry, \\ and may reveal personal user data. | + | * Please save screenshots in .png format. Lossy formats are blurry, \\ and may reveal personal user data. \\ \\ |
| + | * Please wrap bulleted text at less than 50% frame width. \\ It makes things much easier to read/ | ||
| + | * Screenshots in bitmap formats should be scaled/ | ||
| - | | + | * **Avoid quotation marks**. |
| - | + | | |
| - | \\ | + | |
| - | + | ||
| - | * Screenshots in bitmap formats should be scaled/ | + | |
| - | + | ||
| - | \\ | + | |
| - | + | ||
| - | | + | |
| - | | + | |
| - | | + | |
| * **Avoid underlining**. It's been obsolete since the 1980s and makes text harder to read. \\ \\ | * **Avoid underlining**. It's been obsolete since the 1980s and makes text harder to read. \\ \\ | ||
| * **Avoid using the word “Note”**. Put notes in the Notes section that exists \\ at the bottom of most pages.\\ \\ | * **Avoid using the word “Note”**. Put notes in the Notes section that exists \\ at the bottom of most pages.\\ \\ | ||
| * Except in a code window, **command strings should be set in the** '' | * Except in a code window, **command strings should be set in the** '' | ||
| - | * **Variables or process/ | + | * Avoid dividing lines. They' |
| \\ | \\ | ||
| - | * Avoid dividing lines. They' | + | \\ |
style_guidelines.1741455073.txt.gz · Last modified: 2025/03/08 17:31 by hogwild
Page Tools
