102

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

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

24 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.

top 24 comments

sorted by: hot top controversial new old

[-] demesisx@infosec.pub 43 points 3 months ago* (last edited 3 months ago)

NixOS

😉

[-] Scipitie@lemmy.dbzer0.com 20 points 3 months ago

User perspective:

If you want something big I'd pitch nixos. As in the core distribution. It's a documentation nightmare and as a user I had to go over options search and then trying to figure out what they mean more often than I found a comprehensive documentation.

That would be half writing and half coordinating writers though I suspect.

Another great project with mixed quality documentation is openhab. It fits the bill of more backend heavy side and the devs are very open in my experience. I see it actually as superior in its core concepts to the way more popular home assistant in every aspect except documentation!

That said: thanks for putting the effort in! ♥

[-] crudenipster@lemm.ee 12 points 3 months ago

Thank you. I'll look into NixOS as we need Linux documentation to welcome more users from Windows.

[-] Scipitie@lemmy.dbzer0.com 1 points 3 months ago

If that's your intend than it might be better to pick individual arch wiki pages or improve the entry documentation. Many people refer to there from all distro because of its volume.

A "how to read tech documentation" could add value for this target group.

[-] JustEnoughDucks@feddit.nl 16 points 3 months ago* (last edited 3 months ago)

I will go out on a limb and say FreeCAD and KiCAD specifically in examples. Right now you have to search forum posts and videos to find out how to make something work and it is always an older version completely irrelevant to the current version.

For other things that need note basic general and setup documentation:

Traefik: It is only decodable to experienced people right now. I tried about 15 tutorials a few years ago and SmartHomeBeginner was the only one that actually was able to connect to the internet and didn't "rest of the fucking owl" it

Authelia could also use some documentation updates specifically around the area of integrations.

Libopencm3 also could use some more complete documentation instead of basic API descriptions, but the project is not very active anymore

Opensuse Aeon and Kalpa could also use some documentation love, especially Kalpa.

[-] crudenipster@lemm.ee 13 points 3 months ago

FreeCAD looks like a nice project because I'm a mechanical engineer as well. So, I'll look into it.

[-] kent_eh@lemmy.ca 3 points 3 months ago

It's also on the cusp of a major upgrade release, so good documentation of the latest version's features will be in high demand very soon.

[-] theshatterstone54@feddit.uk 13 points 3 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.

[-] vort3@lemmy.ml 11 points 3 months ago

Do you mean the user documentation, or code documentation for contributing to the project?

[-] crudenipster@lemm.ee 13 points 3 months ago

I'm referring to the user documentation.

[-] nrbray@lemmy.ml 6 points 3 months ago

Another suggestion to help on NixOs. There is quite some demand for what NixOs delivers so any work done should benefit from useful feedback.

[-] tiny@midwest.social 3 points 3 months ago* (last edited 3 months ago)

My open source observability project could use some help https://gitlab.com/shiftsystems/shiftmon

[-] Timely_Jellyfish_2077@programming.dev 3 points 3 months ago

Immich. Best Google photos alternative. Can't believe how close it is to Google photos while still being free.

[-] adj16@lemmy.world 4 points 3 months ago

I feel like their documentation is pretty solid..?

[-] Timely_Jellyfish_2077@programming.dev 3 points 3 months ago

So Lemmy won't immediately delete comments in other servers. I deleted this comment immediately after posting.

[-] adj16@lemmy.world 2 points 3 months ago

Been there! No sweat, was just checking open source documentation standards hadn’t gotten ridiculously high recently 🙃

[-] crudenipster@lemm.ee 2 points 3 months ago

Yeah, I love Immich's documentation. Even with my limited experience of YAML files, I was able to host a private web instance of Immich for my photo library.

[-] delirious_owl@discuss.online 2 points 3 months ago

Open Funk. I want more kitchen equipment that wont die when i give it a hard task, and i can repair myself if it does. But I don't know where to begin

[-] pol@infosec.pub 2 points 3 months ago

Nix

[-] pastermil@sh.itjust.works 1 points 3 months ago

Maybe KDE?

Also I find Debian documentations are pretty lackluster.

[-] AnarchistArtificer@slrpnk.net 1 points 3 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.ee 2 points 3 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.

[-] sorter_plainview@lemmy.today 1 points 3 months ago* (last edited 3 months ago)

If you are looking to volunteer on a project, I'm currently working on documentation on an open source project. This one is not a paid job and I'm volunteering my own time for this. If you are interested we can discuss further.

It's a project involving mainly JavaScript and a web based application for the end user.

I can't post links and other details here, since it will directly doxx my account