Authoring Guidelines

From NetBSD Wiki

So you want to create or edit content on this Wiki? That is fine, actually it is appreciated very much. Here are some guidelines.

Use Proper Language

Try to be as concise and precise as possible. Use short and clear sentences. Double check grammar. Ask someone who is a native english speaking person to read and edit your article.

Do not add empty sections, i.e. titles but then no text. Add titles as you add text.

Categorize Your Content

This Wiki will be most useful if the content is properly categorized. Remember that there is an automatically generated page that lists all pages in a certain category, e.g. see the NetBSD on Laptops category. It is perfectly valid (and usually makes sense) to put an article in more than one category.

A list of all available categories can be found here. If you think no existing category matches your content, feel free to add a new category. Keep in mind, however, that it usually makes no sense to have a category that contains only one article.

Keep Your Content Up-to-date

If your article mentions a specific version of a product or software, keep in mind that things evolve. You might want to come back to your article from time to time and check if the content is still current and valid. E.g. if you put a dmesg of your machine in the dmesg category it would be useful if you did the same with newer releases of NetBSD as well.