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
In general if you want to be a good writer, you need to be a good reader first :)
Writing is a good ability you could have so you would be a more valuable person, and also create value. Also writing is a way to express yourself, like in your blog.
Like many other things, you get good by practice. If you enjoy doing it, then just go read and write. Ask for feedback. You’ll get better and better slowly :)
Also may the Source be with you :D
Damn wasn’t expecting this to get philosophical lol. Good points, I didn’t think of documentation through this lens, I was just thinking of writing basic instructions, which might not be as easy for a beginner to understand.
My initial idea was just to use a blog, but it might not be easy to find for people new to the project and having docs as a repo might also allow the devs to change anything when they want as well.