Differences

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

--- wiki:contributing [2021/04/30 16:03] – uninomiconadmin
+++ wiki:contributing [2025/04/15 14:51] (current) – klea
@@ Line 1: / Line 1: @@
 ====== 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.
+Thanks for the interest in contributing to the Uninomicon! Please read this page before adding information.
-==== What Information Should be Here? ====
+**Mission Statement:** The #1 risk to the Uninomicon is information becoming stale. Because of this, strive to write pages that are concise. Short text is vastly easier to update. Favor lists rather than paragraphs when possible. Write like Wikipedia, not like a blog post.
-  - Ordered List Item This wiki is not a replacement for the Unity Documentation; it is a supplement. If a fact exists on the Unity Docs, it should **not** be on the Uninomicon((The shorter the Uninomicon is, the easier it is to skim)).
-  - Pages should contain short-form information((lists, short paragraphs, etc)). It should be easy to //skim// when you are researching a problem. Please write with the fewest words you can.
-  - Do not post long-form guides and tutorials. Instead, post these guides on a blog, and then create a link on from the Uninomicon((Long form text is a *big* maintenance burden, but it is easy to remove a link when it becomes out of date)).
-==== Leave the Uninomicon cleaner than you found it! ====
+==== What information should be here? ====
-  - Follow the style of other pages! Use headers, bullet points, and fold-outs to keep things tidy ((Uninomicon does not use markdown, it uses a DokuWiki format. See the [[https://uninomicon.com/wiki/syntax|Syntax]] guide.))
+  - This wiki is not a replacement for the Unity Docs. If a fact exists on the Unity Docs, it should **not** be on the Uninomicon.
-  - Keep in mind the readability of the page, and add headers/organization as necessary, even if they weren't there before.
+  - Pages should contain short-form information((lists, short paragraphs, etc)). Use the **fewest** words you can to convey the point.
-  - Write concisely! Use the fewest words you can to convey the point. Your readers will thank you. ((Avoid filler words and phrases such as "In this case" "Also", "It also means that".
+  - Do not post long-form guides and tutorials. Instead, post these guides on a blog, and then create a link from the Uninomicon((Long form text is a *big* maintenance burden, but it is easy to remove a link when it becomes out of date)).
-  - Proof-read! Check for grammar, spelling, etc ((If you're not a native English speaker, use a grammar checker like Google Docs, etc))
+  - Favor facts and observations over tips and suggestions. (('Cookbook' style references are great, but become stale quickly as times change. The [[http://wiki.unity3d.com/index.php/Main_Page|Unity Community Wiki]] is a better place for cook-book style recipes.))
+==== Leave the Uninomicon cleaner than you found it! ====
+  - Follow the style of other pages! Use __footnotes__, headers, bullet points, and fold-outs. ((Uninomicon does not use markdown, it uses a DokuWiki format. See the [[https://uninomicon.com/wiki/syntax|Syntax]] guide.))
+  - Take a moment to tidy up the rest of the page, even if you're not editing the other sections.
-Thanks for reading! I manually oversee every edit, so following these rules helps avoid extra work on me. If you're not sure about any of the above rules, don't hesitate to [[https://twitter.com/kleptine|me]] on Twitter.
+Thanks for reading! I manually review every change, so following these rules helps avoid extra work. If you're not sure about any of the above rules, don't hesitate to reach out to [[https://twitter.com/kleptine|John Austin]] on Twitter / X or [[https://bsky.app/profile/johnaustin.bsky.social|John Austin]] on BlueSky.