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/30 00:21]
heather [Distinguish 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 52: Line 57:
 ## Distinguish between a tutorial, a guide, and a reference page ## 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 ​feature or task, and is more advanced and shorter than a tutorial. These can be found in [[gdevelop5:​tutorials|Tutorials and Guides]].+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. 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.
Line 67: Line 72:
 ## Triple check for grammar and mistakes ## Triple check for grammar and mistakes
  
-A page full of mistakes and typos will leave a negative impression on readers. If the documentation is unreliable or bad quality, people may assume the same for GDevelop.+A page full of mistakes and typos will leave a negative impression on readers. If the documentation is unreliable or poorly thought out, people may assume the same for GDevelop.
  
   * Proofread your writing multiple times. ​   * Proofread your writing multiple times. ​