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:season-of-docs [2019/05/15 19:11]
4ian [Frequently asked questions]
gdevelop5:community:season-of-docs [2019/06/18 09:39] (current)
4ian
Line 3: Line 3:
 {{ :​gdevelop5:​community:​seasonofdocs_logo_secondarygrey_72ppi.png?​nolink |}} {{ :​gdevelop5:​community:​seasonofdocs_logo_secondarygrey_72ppi.png?​nolink |}}
  
-Season of Docs is an initiative to bring open source and technical writer communities together.+Season of Docs is an initiative to bring the open source and technical writer communities together.
  
 GDevelop is an *open-source* **game development** software allowing anyone to create games. What makes GDevelop unique and so easy to use are the [[https://​gdevelop-app.com/​|events]]. Events are a powerful way to express the logic of your game, without having to learn a programming language. Want to give it a try? [[https://​editor.gdevelop-app.com|Try the online version]] or [[https://​gdevelop-app.com/​download/​|download the full software]]! GDevelop is an *open-source* **game development** software allowing anyone to create games. What makes GDevelop unique and so easy to use are the [[https://​gdevelop-app.com/​|events]]. Events are a powerful way to express the logic of your game, without having to learn a programming language. Want to give it a try? [[https://​editor.gdevelop-app.com|Try the online version]] or [[https://​gdevelop-app.com/​download/​|download the full software]]!
  
-This year, we would love to mentor a **technical writer** to improve GDevelop documentation! We have a few ideas that could help a lot the software and its users. ​+This year, we would love to mentor a **technical writer** to improve GDevelop documentation! We have a few ideas that could really ​help our users. ​
  
-Dozens of thousands ​of users are creating games with GDevelop each month. ​Lots of them are discovering game creation for the first time. Others are more experienced users creating [[https://​gdevelop-app.com/​games-showcase/​|impressive games]] with the engine.+Thousands ​of users are creating games with GDevelop each month. ​Many users are discovering game creation for the first time. Others are more experienced users creating [[https://​gdevelop-app.com/​games-showcase/​|impressive games]] with the engine.
  
 ## Ideas ## Ideas
Line 17: Line 17:
 **A brand new tutorial 🚀** **A brand new tutorial 🚀**
  
-   * Write a new tutorial, explaining ​step by step how to create a game. We have two complete tutorials on the wiki already, but they are fairly basic. +   * Write a new step-by-step tutorial explaining ​how to create a game. We have two complete tutorials on the wiki already, but they are fairly basic. 
-  * See one of the [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​tutorials/​platform-game/​start|existing ​tutorial ​as an example]].+  * See one of the [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​tutorials/​platform-game/​start|existing ​tutorials ​as an example]].
   * The theme of the game can be anything that sounds interesting:​ space shooter, endless running game, castlevania-like,​ beat'​em up etc... Mentors will help you get started with the software and the game making.   * The theme of the game can be anything that sounds interesting:​ space shooter, endless running game, castlevania-like,​ beat'​em up etc... Mentors will help you get started with the software and the game making.
  
-> It will be important to find a game that is fairly small so that a tutorial can cover it from the start to the end, while being interesting... and good looking 💅 (there are assets pack on websites like *itch.io* or *opengameart.org* that we can use).+> It will be important to find a fairly small game so that a tutorial can cover it from start to finish - but it needs to look good and be interesting(There are asset packs on websites like *itch.io* or *opengameart.org* that we can use.)
  
 **Improved wiki pages 📚** **Improved wiki pages 📚**
Line 27: Line 27:
   * Improve the existing documentation by checking that every object, event, behavior is covered by the documentation and improve each page with new examples, links and explanations.   * Improve the existing documentation by checking that every object, event, behavior is covered by the documentation and improve each page with new examples, links and explanations.
   * See the [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​objects|objects]],​ [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​behaviors|behaviors]],​ [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​events|events]] and [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​all-features|all other features]] pages.   * See the [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​objects|objects]],​ [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​behaviors|behaviors]],​ [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​events|events]] and [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​all-features|all other features]] pages.
-  * These pages will be very useful as the software has "​Help"​ links, inside the editor, for all features. Users will be able to learn more extensively ​about any feature by simply ​clicking on Help.+  * These pages will be very useful as the software has "​Help"​ links, inside the editor, for all features. Users will be able to learn more about any feature by clicking on Help.
  
-**Improved extension developer guide 🤓** +**Improved extension developer guide ** 
  
-  * Extensions are very important ​in GDevelop, as they provide most features that users can use in their games. Improve the documentation on [[https://​github.com/​4ian/​GDevelop/​blob/​master/​newIDE/​README-extensions.md|GitHub]] to explain how to create a new extension for the software. +  * Extensions are an important ​part of GDevelop. They provide ​the most features that users use in their games. Improve the documentation on [[https://​github.com/​4ian/​GDevelop/​blob/​master/​newIDE/​README-extensions.md|GitHub]] to explain how to create a new extension for the software. 
-  * See also this [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​extending-gdevelop|wiki page]]. This will be very useful to encourage new people to contribute to the game engine.+  * Also see this [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​extending-gdevelop|wiki page]]. This will help encourage new people to contribute to the game engine.
  
 **Documentation and tutorial for publishing games on various platforms 🌍** ​ **Documentation and tutorial for publishing games on various platforms 🌍** ​
  
-  * Create more documentation about publishing games on marketplaces,​ gaming websites and app stores. This is super important ​as users like to create games, but a game is not finished if it's not published!  +  * Create more documentation about publishing games on marketplaces,​ gaming websites and app stores. This is a very important ​topic. Users like to create games, but a game is not finished if it's not published!  
-  * There is already ​a bit of [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​publishing|documentation on the wiki]], but more step-by-step tutorials and detailed explanations about marketplaces (Kongregate,​ Itch.io, Facebook Instant Games...) or app stores would be super useful! ​+  * There is already ​some [[http://​wiki.compilgames.net/​doku.php/​gdevelop5/​publishing|documentation on the wiki]], but more step-by-step tutorials and detailed explanations about marketplaces (Kongregate,​ Itch.io, Facebook Instant Games...) or app stores would be very useful! ​
  
  
-> These articles/​documentation can even be tightly integrated into GDevelop app itself. Mentors will be able to do updates in GDevelop.+> These articles/​documentation can even be tightly integrated into the GDevelop app itself. Mentors will be able to do updates in GDevelop.
  
  
Line 47: Line 47:
 GDevelop repository is available on **[[https://​github.com/​4ian/​GDevelop|GitHub]]**. ​ You can also browse the **[[https://​gdevelop-app.com/​|website]]** to learn more about the software and download it. GDevelop repository is available on **[[https://​github.com/​4ian/​GDevelop|GitHub]]**. ​ You can also browse the **[[https://​gdevelop-app.com/​|website]]** to learn more about the software and download it.
  
-📣Participation ​to Season of Docs was announced on [[https://​twitter.com/​GDevelopApp/​status/​1120410655675359234|Twitter]] and [[https://​www.facebook.com/​GDevelopApp/​posts/​10157106427160768|Facebook]].+📣 Participation ​in Season of Docs was announced on [[https://​twitter.com/​GDevelopApp/​status/​1120410655675359234|Twitter]] and [[https://​www.facebook.com/​GDevelopApp/​posts/​10157106427160768|Facebook]].
  
 👋 Mentors will be [[https://​github.com/​4ian|4ian]] and [[https://​github.com/​blurymind|Blurymind]]. 4ian is the original author of GDevelop and Blurymind is an active contributor to the software. You'll also get support from other members of the community on the [[https://​forum.gdevelop-app.com|forum]] or [[https://​discord.gg/​rjdYHvj|the Discord]]! 👋 Mentors will be [[https://​github.com/​4ian|4ian]] and [[https://​github.com/​blurymind|Blurymind]]. 4ian is the original author of GDevelop and Blurymind is an active contributor to the software. You'll also get support from other members of the community on the [[https://​forum.gdevelop-app.com|forum]] or [[https://​discord.gg/​rjdYHvj|the Discord]]!
Line 53: Line 53:
 ## I'm interested! How do we get started? ## I'm interested! How do we get started?
  
-If you have any question, feel free to reach out to 4ian (find my email on my [[https://​github.com/​4ian|GitHub page]], send me an DM on the forum or send me a Tweet).+If you have any questions, feel free to reach out to 4ian (find my email on my [[https://​github.com/​4ian|GitHub page]], send me DM on the forum or send me a Tweet).
  
 Read the page for [[https://​developers.google.com/​season-of-docs/​docs/​tech-writer-guide|Technical Writer on Google Season of Docs]]. After the exploration phase, finishing on May 28, official applications can be submitted. Read the page for [[https://​developers.google.com/​season-of-docs/​docs/​tech-writer-guide|Technical Writer on Google Season of Docs]]. After the exploration phase, finishing on May 28, official applications can be submitted.
Line 63: Line 63:
 **Is it possible for me to contribute to GDevelop in Google Season of Docs given that I don’t have any prior experience in coding or technical writing but have used GDevelop in the past?** **Is it possible for me to contribute to GDevelop in Google Season of Docs given that I don’t have any prior experience in coding or technical writing but have used GDevelop in the past?**
  
-Yes! You'll get familiar with GDevelop as you use it before the project officially ​start. There is notably a period for this in August that is called "​community bonding"​.+Yes! You'll get familiar with GDevelop as you use it before the project officially ​starts. There is notably a period for this in August that is called "​community bonding"​.
  
-**How should I express my interest ​for contributing towards a project and whom should I express it towards?**+**How should I express my interest ​in contributing towards a project and whom should I express it towards?**
  
-Submit an official application ​when applications are open (in June, see [the timeline](https://​developers.google.com/​season-of-docs/​docs/​timeline)). Also write to 4ian about what you would like to do.+Submit an official application! Find the link here: https://​developers.google.com/​season-of-docs/​docs/​tech-writer-guide 
 + 
 +**What should be in the proposal? What is the format of the proposal?​** 
 + 
 +Read the guide here: https://​developers.google.com/​season-of-docs/​docs/​tech-writer-application-hints 
 + 
 +* A bit of information about your experience and who you are. Tell us if you have experience with **GDevelop** (existing tutorials, games, etc...or **game development** in general :) 
 +* Description of what you want to do, why it's interesting,​ what you will include, etc... 
 +* The GDevelop project for GSoD will surely be *standard-length*. 
 +* No particular format - you are the technical writer, so it's up to you to judge what's best :)
  
 **Will there be enough help given that I will be contributing towards the documentation rather than the project?** **Will there be enough help given that I will be contributing towards the documentation rather than the project?**
Line 73: Line 82:
 Absolutely, documentation is key for GDevelop, so the authors/​maintainers of the software will be able to support you and will communicate regularly with the technical writer to help. Absolutely, documentation is key for GDevelop, so the authors/​maintainers of the software will be able to support you and will communicate regularly with the technical writer to help.
  
-**How many technical writers will be able to partipicate?**+**How many technical writers will be able to participate?**
  
-Unfortunately,​ only 1 it seems. Note that participating ​to tutorials and the documentation is already possible! If you create an account on the wiki, you are able to edit existing pages to improve ​thme or create new pages for tutorials.+Unfortunately,​ only 1. Note that participating ​in tutorials and the documentation is already possible! If you create an account on the wiki, you can edit existing pages to improve ​them or create new pages for tutorials.
  
 **What does GDevelop need?** **What does GDevelop need?**
  
-More documentation and tutorials for people to create various games mainly :) See the list of ideas. The best thing to do is also to browse the forum to see what people are asking. ​It's a good way to see what are the main issues users are running into.+More documentation and tutorials for people to create various gamesmainly :) See the list of ideas. The best thing to do is to browse the forum to see what people are asking. ​The forum highlights ​the main issues ​that users encounter.
  
 Step by step tutorials seems to be the most useful for new users. Step by step tutorials seems to be the most useful for new users.
 +
 +**What specific skills are you searching for, for technical writers?**
 +
 +Programming skills are not required, but these will be good to have:
 +
 +* Ability to write English in a readable manner without mistakes
 +* Autonomy
 +* Game creation skills (with or without GDevelop) - will be important for example to create a new, interesting tutorial.
 +* Ability to use GDevelop
 +* Good interactions with the game making community (GDevelop or the broader game development community)
 +
 +**Can you guide me toward what I should exactly include in the proposal?**
 +
 +No :) As a technical writer, it's up to you to make your mind around the GDevelop ecosystem and existing documentation,​ and, according to the project ideas (or your own ideas), describe what you think would be best to do. 👍