107

Share your fav open-source projects that could use detailed getting started guide. (lemm.ee)

submitted 2 months ago by crudenipster@lemm.ee to c/opensource@lemmy.ml

25 comments fedilink hide all child comments

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.

you are viewing a single comment's thread
view the rest of the comments

[-] theshatterstone54@feddit.uk 14 points 2 months ago

I know 2 people have already said it, but NixOS is in very desparate need of documentation. It's so immensely difficult and at a certain point the learning curve feels more like a vertical line than a curve, so that's my top pick.

Other than that, I recently tried a project called Bluebuild and its docs are very incomplete (also the project doesn't work for me but that's another topic).

In fact, the topics of packaging software and creating (custom) live isos are both very underdocumented in general.

So packaging for deb and rpm is also quite difficult to find good and easy to follow docs and guides for.