[2024-feb-29] Sad news: Eric Layton aka Nocturnal Slacker aka vtel57 passed away on Feb 26th, shortly after hospitalization. He was one of our Wiki's most prominent admins. He will be missed.
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
| slackdocs:styleguide [2012/09/03 23:20 (UTC)] – Several small fix-ups. alienbob | slackdocs:styleguide [2012/09/05 16:13 (UTC)] – [A General Note on Style] hazel | ||
|---|---|---|---|
| Line 95: | Line 95: | ||
| * Write complete sentences and try to avoid grammatical errors. If English is not your native language, you can always get help from an English editor. | * Write complete sentences and try to avoid grammatical errors. If English is not your native language, you can always get help from an English editor. | ||
| * Follow proper [[http:// | * Follow proper [[http:// | ||
| - | * Long passages of plain text are hard to read; always consider if something can be better expressed using a list format. Use numbered lists only for sequential operations, bulleted lists for options or examples (as shown here). | + | * Long passages of plain text are hard to read; always consider if something can be better expressed using a list format. Use numbered lists only for sequential operations, bulleted lists for options or examples (as shown here). Sometimes a table or a flowchart can be useful. |
| * If quoting computer output, reproduce it exactly, including spelling (which is usually American). Use %%< | * If quoting computer output, reproduce it exactly, including spelling (which is usually American). Use %%< | ||
| + | * If your text has examples of key presses, use the %%< | ||
| + | * Avoid the passive voice. Use it only when alternatives would be clumsy. | ||
| + | * Try to avoid long-windedness. "To do x, use the -y option" | ||
| Line 115: | Line 118: | ||
| If you think that a Wiki page (written by somebody else or by yourself) is in need of attention from the admin team, you can add a tag " | If you think that a Wiki page (written by somebody else or by yourself) is in need of attention from the admin team, you can add a tag " | ||
| - | When should you use this? For instance, you find an incomplete or badly written text or even an empty page (this can happen if someone writes a non-english | + | When should you use this? For instance, you find an incomplete or badly written text or even an empty page (this can happen if someone writes a non-English |
| ===== See Also ===== | ===== See Also ===== | ||
