Open Source

31218 readers

305 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] 16 points 2 months ago* (last edited 2 months ago) (1 children)

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.

[–] [email protected] 13 points 2 months ago (1 children)

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

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