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 (2 children)

You need to Jack Webb that shit and stay away from flowery prose. A good resource is to read all of your household electronics manuals with a critical eye.

  • permalink
  • fedilink
  • source
  • hideshow 2 child comments
    •
  • [–] [S] 2 points 1 month ago (1 child)

    Idk who Jack Webb is 😅, but I agree with you, I'm not thinking of flowery prose, but basic steps and instructions for a beginner to get started. Thanks!

  • permalink
  • fedilink
  • source
  • parent
  • hideshow 1 child comment
    •
  • [–] 4 points 1 month ago

    Jack Webb was a detective on an old 1950's series called "Dragnet". Often, when interviewing people during an investigation, they would start editorializing and he would always stop them and say "Just the facts, ma'am" or "Just the facts, sir". I'm old and my references are old. Good luck and all the best!

  • permalink
  • fedilink
  • source
  • parent