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

Automating video

Chapter 7 mentioned how many new learners prefer to learn from videos, and the chapter covered some of the lengthy requirements and work needed to create a video. Even once you’ve created one, they are also hard and time-consuming to keep up to date. Can you automate creating them?

The answer is, as always, it depends. The easiest to automate is any terminal examples. Let’s start there.

Converting terminal commands to video

Perhaps the best-known is Asciinema (https://docs.asciinema.org). After you run its terminal command, it starts “recording” terminal input and output until you stop recording. You can then either embed that recording in documentation by loading the local recording file into some JavaScript or upload it to Asciinema’s site (which is free) and, again, embed it with some JavaScript. You can configure a lot of settings when you generate a recording, but even more interesting is that until you host the recording...

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