6 resources for starting your journey into docs!
Do you find yourself in the shoes of someone who has to write documentation for the first time ever? The closer you look, the more you will find that technical writing is actually quite a broad discipline. Amidst the tons of resources, it can be hard to figure out what you need to know to get started. So here are six resources to narrow that space for you.
Learning the basics
It can be tempting to start writing down your thoughts all in one document. But what makes perfect sense to you isn’t necessarily easy to digest for your users. In technical writing, scoping information and ordering it logically are critical to keep your audience from getting lost.
βοΈ Google Tech Writing Course: Tech writers at Google developed this course for software engineers they work with. It covers the very basics of writing understandable documentation. It is a great starting point, especially if you feel like you’re not a strong writer (yet).
π Docs for Developers: This book explains beautifully what to focus on when you build your documentation for the first time. In contrast to the Google tech writing course, the book focuses less on the stylistic elements of writing and more on the whole documentation process from conception to publication and measuring documentation quality. I definitely recommend reading it before starting your writing process.
Writing - Let’s get to it
After working on your foundational understanding of technical writing, you will have a clearer picture about how to organize your content and how to scope it. Next comes the hard part: getting words on to a blank page.
π The Good Docs project templates: This repository contains all the guts and glory that the Good Docs project is working on: Templates! Our aim is to help you write awesome documentation. If you have questions about how to use a template or want to work on a template, join our Good Docs Slack channel. We look forward to seeing you around!
πΊ Write the Docs YouTube channel: Sometimes we face writing struggles and don’t know how to solve them. Most likely, someone else had to overcome a similar challenge and has shared their knowledge in the form of a talk. You can find practical topics like selecting a documentation tool, crafting good error messages, and many other well-crafted talks on the Write the Docs YouTube channel.
Networking - It takes a village
When I am learning something new, my mind is buzzing, and I want to bounce around ideas. Luckily, you can find like-minded people from all over the world in wonderful documentation communities.
π Write the Docs: This group consists of documentarians who mostly work on software. Write the Docs holds networking events like Meetups and conferences, and hosts a Slack channel for in-between communication. The community is very diverse in terms of location, age, and identities. It’s a warm and welcoming place with a lot of friendly faces to bounce around ideas with.
π Society for Technical Communication: The Society for Technical Communication (STC) is an American professional organization for technical writers from every field and domain you can imagine - from government-related domains, to hardware documentation, to software documentation. STC holds conferences and chapter meetings, which are free most of the time. STC also fosters relations with the academical side of documentation and provides certification and regular publications; these require a paid membership.
Tip of the iceberg
The technical writing discipline is dynamic and growing, and more knowledge is being shared every day. What helpful resources have you discovered during your tech writing journey? Share them in our Good Docs Project Slack or @ us on Twitter!
Happy writing!
Text of article Β©2024 Tina Luedtke
Photo by Matthew Sleeper on Unsplash.