Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
gdevelop5:community:contribute-to-the-wiki [2019/07/28 17:15]
heather [Make the distinction between a reference page and a tutorial]
gdevelop5:community:contribute-to-the-wiki [2019/09/05 20:33] (current)
4ian [Ordering of sections]
Line 22: Line 22:
  
 Adding `<​note>​` is fine and encouraged though. Adding `<​note>​` is fine and encouraged though.
 +## When to use bold, italic and quotes?
 +
 +* To refer to element of the interface, prefer the quotes. Example: click on "Add an object"​.
 +* Bold is for **very important things** (details not to be forgotten). Use italic for emphasising some part of a sentence without being as visual as bold - so for things that are _less important_.
 +* For expressions/​mathematical formula or code, use the backticks: `Object.X() + 3`.
  
 ## Ordering of sections ## Ordering of sections
Line 30: Line 35:
 ## Keep it concise and professional ## Keep it concise and professional
  
-The documentation is used by everyone, from kids to professional game developers. Keep your writing concise and direct in the reference pages. It'​s ​ok to refer to the reader by "​you" ​or "​we", ​but only as needed+The documentation is used by everyone, from kids to professional game developers. Keep your writing concise and direct in the reference pages, and aim for a friendly, professional tone. It'​s ​OK to refer to the reader by "​you"​, but avoid the use of "​we"​. You're not doing the work for the readerafter all.
  
 For example: For example:
Line 50: Line 55:
   * Better header: **"​Integrating ads using Google Admob"​**   * Better header: **"​Integrating ads using Google Admob"​**
  
-## Distinguish between a reference page and a tutorial+## Distinguish between ​a tutorial, a guide, and a reference page 
 + 
 +A **tutorial** provides detailed instructions for beginners in simple game creation, with step-by-step screenshots ​and explanations. A **guide** focuses on one specific task, and is more advanced and shorter than a tutorial. These can be found in [[gdevelop5:​tutorials|Tutorials and Guides]]. 
 + 
 +Almost everything else in the wiki is a **reference page**. A reference page should explain a concept or a feature, and give the reader a solid understanding of where and how they would use it. Assume the reader has already completed the tutorials and that they understand the basic game making concepts when writing a reference page, and only explain what is new. 
 + 
 +For example, avoid explaining how to add an object in a page about a specific type of object. People reading these help pages will already have added objects. They want to know what this specific object is used for and why, not how to add it on the screen. 
 + 
 +Similarly, in specific object pages, avoid explaining things that are common to all objects, like rotating the object. ​ This should be [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​objects/​base_object|part of this common page]]. 
  
-A **tutorial** provides detailed instructions about how to do something, with step-by-step screenshots and explanations. Tutorials are in the "​Tutorials and Guides"​ section. +*Use your judgement. It's fine to add more in-depth explanations,​ GIFs, or screenshots for complex features - in particular when related to extensions (Physics, Tween, etc...).
-* Almost everything else in the wiki is a **reference page**. It should contain a quick introduction to the concept, but be more concise than a tutorial. Assume the reader has already completed the tutorials and that they understand the basic game making concepts when writing a reference page, and only explain what is new. +
-* For example, avoid explaining how to add an object in a page about a specific type of object. People reading these help pages will already have added objects. They want to know what this specific object is used for and why, not how to add it on the screen. +
-* Similarly, in specific object pages, avoid explaining things that are common to all objects, like rotating the object. ​ This should be [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​objects/​base_object|part of this common page]]. +
-* This being said, it's fine to add more in-depth explanations,​ GIFs, or screenshots for complex features - in particular when related to extensions (Physics, Tween, etc...).+
  
 <note tip>You may be asking: "Sure, but does extra explanation really hurt?"​. No, but it should take the form of links to other pages whenever possible. Redundant explanations across the wiki make the articles harder to maintain when the software evolves - and the documentation is the most important asset after the software itself.</​note>​ <note tip>You may be asking: "Sure, but does extra explanation really hurt?"​. No, but it should take the form of links to other pages whenever possible. Redundant explanations across the wiki make the articles harder to maintain when the software evolves - and the documentation is the most important asset after the software itself.</​note>​
  
-## Triple check grammar and mistakes+## Triple check for grammar and mistakes
  
-A page full of mistakes and typos will have a negative ​impact ​on readers, ​that will think of GDevelop ​as something of bad quality and unreliable.+A page full of mistakes and typos will leave a negative ​impression ​on readers. If the documentation is unreliable or poorly thought outpeople may assume the same for GDevelop.
  
-Proofread multiple times what you're writingPrefer ​short sentences ​to longer ones.+  * Proofread ​your writing ​multiple times. ​ 
 +  * Use short sentences ​over longer ones.  
 +  * Remember that plain language is always best, and use correct terminology
  
 +By following this guide, we can build consistent, professional documentation for the GDevelop community.