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

  • PandaInSpace@kbin.earthOP
    link
    fedilink
    arrow-up
    1
    ·
    5 days ago

    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.

    • Farooq@realbitcoin.cash
      link
      fedilink
      arrow-up
      1
      ·
      3 days ago

      In your blog you can write tutorials. Or if you had trouble getting something done, you can write how did you do it. They will be good useful notes for other people, possibly including your future self :)