Share your fav open-source projects that could use detailed getting started guide. - eviltoast

Hi,

I’m a technical writer looking to build my portfolio in technical documentation. I’ve written technical blogs, how-to guides, and white papers for SaaS brands, but I want to gain experience working on back-end documentation.

I’m familiar with Python, HTML, CSS, C/C++ (to some extent), and SQL. Additionally, I’ve done considerable writing for cloud computing clients, so I have a solid understanding of cloud concepts.

I can work with Markdown, Git, or even Google Docs.

Please let me know if you’re working on an open-source project that could use some documentation. Alternatively, if you know of an existing open-source tool that could benefit from documentation, I’d be happy to contact the developer.

  • AnarchistArtificer@slrpnk.netEnglish
    1·
    2 months ago

    Elsewhere in this thread, you mentioned that Immich has great documentation. Are there any other FOSS projects that stand out to you as having great user documentation?

    • crudenipster@lemm.eeOP
      2·
      2 months ago

      I think that’s true for most the popular FOSS projects as great documentation is an essential ingredient for getting more users.

      That said, if I have to name one, I love the docs of Plex Meta Manager (now called Kometa). It has step-by-step guides, reference pages, and even example code to help the users.