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

Technical blog posts

A blog post is an end-to-end, self-contained piece of content, normally outside of documentation, that teaches the reader a practical technical lesson.

While not always a content type a documentarian is asked to write, you may be asked to help out, especially in smaller companies where you are one of the few people with the desire and skills to communicate clearly. Blog posts are often a good way to learn about a product or feature from start to finish. As blogs are usually promoted by marketing, outside of QuickStarts, they are also often the first way someone discovers a project, so they are worth doing well.

Much of the advice on structure and language presented in this book for documentation also applies to technical blog posts. There are a couple of main differences.

People generally read documentation when they need to, dipping in and out to find the information they need at the time, whereas most people read a blog post from start to finish, hopefully...

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