This page contains the details of a technical writing project accepted for Google Season of Docs.
- Open source organization:
- Technical writer:
- David Turnbull
- Project name:
- Design the optimal learning experience for beginners
- Project length:
- Standard length (3 months)
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.
Step 3: Improve the information architecture
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.