Open Source

31218 readers

287 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 2 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] 1 points 2 months ago (1 children)

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?

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