42
Any resources on how to start writing documentation for an open source project ? (kbin.earth)
submitted 1 month ago by to c/opensource@lemmy.ml
17 comments fedilink hide all child comments
 

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

you are viewing a single comment's thread
view the rest of the comments
[–] 7 points 1 month ago (1 child)

You can often search for "[your topic] university pdf" to find good resources.

Here is one of the results I found searching "technical writing university pdf"

https://prowriting.web.illinois.edu/wp-content/uploads/2024/07/Open-Technical-Writing_-An-Open-Access-Text-for-Instruction-in-Te.pdf

Maybe there is more when searching for "writing documdntation university pdf".

  • permalink
  • fedilink
  • source
  • hideshow 1 child comment
    •