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

Interactive experiences

The final non-text addition to documentation is a little harder to define, but it builds upon everything else covered in this chapter. There are certain products and concepts you need to explain that are harder or more abstract for readers and potential users to understand. Maybe it’s a new paradigm, or it consists of many interrelated components, or the sheer number of possibilities makes it hard for people to understand where to start.

In these cases, an interactive way of showing concepts can help as it’s a way for people to experiment with your product and see results directly. Many people learn by trying and practical experimentation. While code examples people can copy and paste are one aspect of this, they are also a place to lose people as they dive into their text editor and the trials and tribulations of running applications locally. Replicating a way for people to do the same directly inside documentation keeps them inside the documentation...

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