[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.

Welcome to the Slackware Documentation Project

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
slackdocs:styleguide [2012/09/02 01:18 (UTC)] – clarification and explanation - Editorial Policy nocturnal.slackerslackdocs:styleguide [2012/09/03 21:33 (UTC)] – change capitalization point - added link nocturnal.slacker
Line 34: Line 34:
 ==== Commentary ==== ==== Commentary ====
  
-Regarding the Core namespaces **slackware**, **slacdocs**, and **slackbook**; these are the heart of this project. While howtos and other sections of the wiki are also important to the project, the Core documentation is the reason for all our efforts here. With this in mind, the Staff believes that content in these sections should be more minutely edited and maintained. The exactitude with which the community cares for these Core documents will be appreciated by those using this project as a resource in their learning and continuing use of Slackware Linux.+Regarding the Core namespaces **slackware**, **slacdocs**, and **slackbook**; these are the heart of this project. While howtos and other sections of the wiki are also important to the project, the Core documentation is the reason for all our efforts here. With this in mind, the Staff believes that content in these sections should be more minutely edited and maintained. The more exacting oversight utilized in the care of these Core documents will be appreciated by those using this project as a resource in their learning and continuing use of Slackware Linux.
  
 Thank you for your understanding and cooperation in this matter. Thank you for your understanding and cooperation in this matter.
Line 100: Line 100:
 The button bar at the top of the edit window contains buttons for easy creation of these notification boxes. The button bar at the top of the edit window contains buttons for easy creation of these notification boxes.
  
 +=====A General Note on Style====
 +
 +This is a wiki so a certain degree of informality is acceptable. This includes, for example, conversational contractions such as "you've". Readers should feel that they are talking to a knowledgeable friend rather than reading a manual. However, any appearance of sloppiness must be avoided.
 +  * Do not use slang or "textspeak".
 +  * 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://www.writersblock.ca/tips/monthtip/tipmar98.htm|capitalization rules]] for words in titles and headings.
 +  * 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).
 +  * If quoting computer output, reproduce it exactly, including spelling (which is usually American).
 ===== Translating a Page ===== ===== Translating a Page =====
  

Trace:

slackdocs:styleguide ()