User Tools

Site Tools


wiki-contributions-style-guide

This is an old revision of the document!


Contributing to the FARPN Wiki / Style Guide

Contributions to the FARPN Wiki are welcome and encouraged! Cleaning up or editing an existing page, or adding new pages and tutorials are great ways to get involved. Please reach out via our Matrix chat in the #Wiki room in order to get started. We'll get you set up with an account, and answer any questions you might have.

Wiki Page Requirements

These are the only strict rules around editing the wiki.

  1. Thou shalt use alt-text to describe images.
  2. Do not copy-and-paste from other pages to create pages here (except for N6CTA's blog). If you are incorporating a substantial piece of material, make sure that it falls under a permissible license to post it here.

Style Guide

Below are a few best practices that we encourage for the Wiki.

Writing Style

Try not to write in the first person, but writing tutorials with “we” and “you” is acceptable. When editing, try to follow the existing writing style than completely rewriting it.

Where possible, be clear and concise.

Keep examples as simple as possible. Clearly denote what parts of examples must be changed by the person following them. It is good to define the information to change before providing example text.

Clearly designate things that are optional, or may only apply in certain situations.

Always specify the filename and suggested location before providing any example text.

Formatting

Use

''two-single-quotes''

around program and file names.

Put

<code>

and



</code> tags around any big blocks of configuration files or program examples. (This is kinda meta and i need to fix it - hit edit to see what I mean!)

Use headings liberally, with the highest level heading for the page title, sections with the second highest level, and sub-sections with the third highest level. Do not skip levels of headings.

wiki-contributions-style-guide.1731906385.txt.gz · Last modified: 2024/11/18 05:06 by kc2ihx