Reader small image

You're reading from  Technical Writing for Software Developers

Product typeBook
Published inMar 2024
PublisherPackt
ISBN-139781835080405
Edition1st Edition
Right arrow
Author (1)
Chris Chinchilla
Chris Chinchilla
author image
Chris Chinchilla

Chris Chinchilla spent years as a developer before switching to helping people understand code better instead of writing it. He has worked crafting documentation for many developer-focused projects, from small open-source projects to large and well-known tools and products, tackling everything from tooling to videos. He is known for bringing developers and writers closer with editor and automation-based tools. Outside of tech writing, he publishes fiction, YouTube videos, podcasts, and music. In short, he loves to communicate and find the best medium for the message.
Read more about Chris Chinchilla

Right arrow

What to document

If you are starting an entire set of documentation or a major feature from scratch, you might be wondering what to work on first and how much documentation you need.

At the risk of repeating myself, documentation is an iterative process, especially if you are a small team or undertaking documentation as part of another role. It’s almost impossible for you to document everything that a product might need at once. Unless you work in a sector where completeness and full accuracy are essential at launch, such as medical, sensitive industrial, and so on, then it’s unlikely you need everything documented at once.

So, where do you start? And how do you proceed after you start? If you have some existing metrics or roadmap that informs you of an order to document a product, then follow it, but in reality, it’s unlikely you will have any existing guidance, and it’s mostly “up to you.”

My general advice is to start at the beginning...

lock icon
The rest of the page is locked
Previous PageNext Page
You have been reading a chapter from
Technical Writing for Software Developers
Published in: Mar 2024Publisher: PacktISBN-13: 9781835080405

Author (1)

author image
Chris Chinchilla

Chris Chinchilla spent years as a developer before switching to helping people understand code better instead of writing it. He has worked crafting documentation for many developer-focused projects, from small open-source projects to large and well-known tools and products, tackling everything from tooling to videos. He is known for bringing developers and writers closer with editor and automation-based tools. Outside of tech writing, he publishes fiction, YouTube videos, podcasts, and music. In short, he loves to communicate and find the best medium for the message.
Read more about Chris Chinchilla