Technical writing workshop — Fedora Linux

2 min readOct 20, 2023

Looking for amazing people working with documentation

The idea behind a virtual writing session is to promote advocacy of writing and maintaining excellent user documentation. Here is why.

Documentation in any free and open source software project provides reasons for users and contributors to stay loyal to the project and software.
The Docs workshop aims to facilitate individual and collaborative work through a supportive community of documentarians.
Documentation is more than a fix of visual presentation. We’re writing, reviewing, and deploying docs.
In accordance with the Fedora project motto “First”, we like to try new things in toolset, automation, and UI improvement.

Pre-requisites

We use Free and Open Source Software (FOSS) for writing and collaboration.

If you are unsure where to start, don’t worry. We can create one on the go. We’ll help you get familiar with them.

Workshop timetable for October — December 2023 is as below.

Technical review 1 — Quick Docs

View in your time zone
26 October 2023 UTC 18:00–19:00

Jitsi Meeting link for October is here.

We’ll start with a slightly gentler step “Technical review 1”.

5 min intro, 5 min walk-through of Quick Docs (How-to guide and tutorial for Fedora Linux)
Types of articles that need attention
Show and tell about UI text in Pagure
Interactive session
Share results, Q&A
How to continue Docs journey and weekly meeting

Onboarding
16 November 2023 UTC 08:00–08:30

Jitsi Meeting link for November is here.

Target audience

You use software run on Linux desktop and/or server to get the job done
You love to document tools, features, and how-to guides, which require care and maintenance to ensure technical accuracy and conformance to documentation style guide
You can help optimize the graphical and functional appearance of Fedora Quick Docs and curation
You are interested in Docs toolchain
You want to gain experience on technical writing

Technical review 2 — Quick Docs
7 December 2023 UTC 08:00-09:00

We will rotate meetings to accommodate a more diverse array of time zones. The link will be updated every month in the Fedocal.

Technical review workshop will be recorded and shared on PeerTube so that others can watch at a later time.

I’m looking forward to saying hello at our docs workshop.

If you missed the workshop, please watch it online here.

Git, vale linter, Podman, Cauldron.io

Let’s do it!

#FedoraLinux #OpenSource #Linux #docs #technicalwriting #reading