Open Source

31654 readers

185 users here now

All about open source! Feel free to ask questions, and share news, and interesting stuff!

Useful Links

Rules

Posts must be relevant to the open source ideology
No NSFW content
No hate speech, bigotry, etc

Related Communities

Community icon from opensource.org, but we are not affiliated with them.

founded 5 years ago

MODERATORS

[email protected]

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

submitted 3 months ago by [email protected] to c/[email protected]

23 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

[–] [email protected] 19 points 3 months ago (1 children)

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! ♥

[–] [email protected] 12 points 3 months ago (1 children)

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

[–] [email protected] 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.