Open Source

31088 readers

1126 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]

104

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]

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

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

if you don't mind me asking, how did you become a technical writer?

[–] [email protected] 3 points 2 months ago

I graduated as a mechanical engineer in 2020, but with corona and other economic factors, the job market wasn't great.

That said, I was already working as a freelance writer for different brands via Upwork by then — since I had seen the writing on the wall after watching previous year's graduates.

Fast forward to now, I've worked for different SaaS brands, web hosting companies, and manufacturing businesses.

I've written knowledge base articles, user guides, technical white papers, and faq articles.

However, I'm still not an expert as my experience with user manuals, software documentation, and so on is bit lacking.