Uninomicon

Documenting the dark corners of the Unity Engine.

User Tools

Site Tools


wiki:contributing

This is an old revision of the document!


Contributor Guide

Thanks for the interest in contributing to the Uninomicon! Please read this page before adding information, so that I don't have to re-edit your submission.

What information should be here?

  1. This wiki is not a replacement for the Unity Docs; it is a supplement. If a fact exists on the Unity Docs, it should not be on the Uninomicon1).
  2. Pages should contain short-form information2). Please write with the fewest words you can. It should be easy to skim.
  3. Do not post long-form guides and tutorials. Instead, post these guides on a blog, and then create a link from the Uninomicon3).

Leave the Uninomicon cleaner than you found it!

  1. Follow the style of other pages! Use headers, bullet points, and fold-outs. 4)
  2. Take a moment to tidy up the rest of the page, even if you're not editing the other sections.
  3. Write concisely! Use the fewest words you can to convey the point. Your readers will thank you. 5)
  4. Proof-read! Check for grammar, spelling, etc. 6)

Thanks for reading! I manually edit every change. Following these rules helps avoid extra work. If you're not sure about any of the above rules, don't hesitate to me on Twitter.

1)
The shorter the Uninomicon is, the easier it is to skim
2)
lists, short paragraphs, etc
3)
Long form text is a *big* maintenance burden, but it is easy to remove a link when it becomes out of date
4)
Uninomicon does not use markdown, it uses a DokuWiki format. See the Syntax guide.
5)
Avoid filler words and phrases such as “In this case” “Also”, “It also means that”.
6)
If you're not a native English speaker, use a grammar checker like Google Docs, etc
wiki/contributing.1619798865.txt.gz · Last modified: 2021/04/30 16:07 by uninomiconadmin