# Use simple English. # Don't write like an academic. # Never use the word **one** when you mean **you**: # **Wrong**: One should install the package by running `$ doas pkg_add tcl` # **Right**: `$ doas pkg_add tcl` # Avoid excessive jargon # Define the first use of uncommon abbreviations # Avoid slang # Be concise # **Wrong**: You have now successfully turned from what was a comment into an actual parameter. You will need to uncomment and set any line that begins with semi-colon (;) character at the beginning of the line for any feature that you want. **Without removing that semi-colon that feature is either disabled or the defaults are used!** # **Right**: Put a semi-colon (;) in front of a line to comment it out. Remove it to uncomment it. # **Wrong**: I personally do not condone the notion of using FQDN that does not belong to you, as the consequences of going public with the named servers //can// potentially end up in lawsuits, for falsely misrepresenting a domain name. # **Right**: Don't use a domain you don't own. # Use the active voice, not the passive. # One paragraph for each new topic, and start each paragraph with a topic sentence # One main topic per page. If you have multiple topics, create multiple pages and link to those pages. # Avoid repeating too much unnecessary content that is already better described elsewhere. # If content is described better on another page, link to that page instead of repeating material. This makes it easier to update and maintain content. # For example, an article about ngircd should not spend too much time talking about the TCP/IP client-server model. Instead, link to that page. # Keep track of the difficulty level of each article and keep it in mind when writing. # Avoid markup that is purely cosmetic. Markup should be used to indicate the structure and meaning of content. # Show don't tell. If you want someone to read a man page, just link to it, don't tell him to type $ man # It is OK to be opinionated, but defend it with evidence # If there is a strong disagreement, create a separate page or a separate category. # In codeblocks, use to indicate sections of code that should be replaced with a user-specific value ##STARTCODEBLOCK## ports = 6667,6697 IP = <192.168.1.1>##ENDCODEBLOCK## # Avoid formatting options that only make the text look nice; use tags that convey meaning # **Right**: codeblocks, tables, Emphasis, Headings, Subheadings, indentation for quotes # **Wrong**: Horizontal rules, indentation other than quotes # In case if there are multiple guides for same task, sort them. (for example sort IRC Clients based on OS)