I’ve been thinking of contributing to foss projects with more than testing and bug reporting. I want to contribute to mainly open source game engines. There are a few that are mature and underrated, but lack any documentation for a user to get started. This is why I decided to do documentation, but I don’t know where or how to start.
Is there any general rule/guidelines for getting started with this ? I’m looking for anything that can help a beginner documentation writer
If you want to write something user focused, Rust by Example is a great template to use.
A series of self contained lessons that all build on each other.
If you’re doing it for a game engine, you’d probably want to start with the GUI, then some basic scripting (that can go much deeper, but I’d keep it short and share other resources). Once that’s out of the way, show some examples of how to import assets, how to manage a project directory, etc.
Keep all of this contained within the framework of making a simple game, so when the reader completes the tutorial/documentation, they have something that they can actually show off.
I also like the Odin docs since it’s all one page and shows you features in order.
Really like the Rust example, might use that as a template. I am thinking of using a simple pong game to get started. Thank you for all the suggestions as well.