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

  • melsaskca@lemmy.ca
    link
    fedilink
    arrow-up
    6
    ·
    2 days ago

    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.

    • PandaInSpace@kbin.earthOP
      link
      fedilink
      arrow-up
      2
      ·
      15 hours ago

      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!

      • melsaskca@lemmy.ca
        link
        fedilink
        arrow-up
        3
        ·
        15 hours 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!