GDevelop project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- GDevelop
- Technical writer:
- David Turnbull
- Project name:
- Design the optimal learning experience for beginners
- Project length:
- Standard length (3 months)
Project description
Step 1: Perform a content audit
This means diving deep into the existing documentation and getting a broad understanding of how GDevelop works and what new users might find most captivating about it. I'll also follow the existing tutorials and note down any stumbling blocks I face.
Step 2: Rewrite the ""Getting started"" guide
When a user reads the GDevelop documentation, their first stop is probably the ""Getting started"" guide, but the guide itself isn't that exciting — it just talks about installing GDevelop, opening a project, etc. I'd like to rewrite this guide to have users accomplish something, even if that ""something"" is small (like adding an object to a game). I'd also like to provide clearer next steps, as the current guide provides a lot of links at the end of it, which may overwhelm users with the paradox of choice.
The GDevelop documentation has some great content — the tutorials in particular are really nice — but that content is not necessarily surfaced in the best way possible. Using what I learn from the content audit, I'd like to investigate how the content and navigation can be reorganized so users find the content they need when they need it.
Other tasks/opportunities will surely come up during the project — once I get started on a documentation project, I can't help but be consumed by it — but I feel like these steps lay a strong foundation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["This project aims to enhance the learning experience for beginners using the GDevelop game development platform."],["The project involves a content audit, rewriting the \"Getting Started\" guide to be more engaging, and improving the overall information architecture of the documentation."],["The goal is to make it easier for new users to learn GDevelop and find the information they need efficiently."],["This is a Google Season of Docs project, led by technical writer David Turnbull, focusing on the open-source GDevelop platform over three months."]]],["The core of this Google Season of Docs project involves improving the GDevelop documentation. Key actions include conducting a content audit, rewriting the \"Getting started\" guide to be more engaging and providing clearer next steps, and improving the information architecture of the documentation. The project aims to enhance the learning experience for beginners by addressing content organization and user engagement. This project is intended to take 3 months.\n"]]
