Technical Writing for Software Developers

7

Handling Other Content Types for Comprehensive Documentation

The last couple of chapters looked at the principles, processes, and tools involved in the process of creating words that form documentation. This chapter covers what else you can add to documentation to help people learn beyond words. It covers the following topics:

• Code examples
• Screenshots, images, and charts
• Animated GIFs and videos
• Interactive experiences

For each of these, the chapter covers what adding those elements brings to documentation, how to add and maintain those elements, and the positives and negatives of using those elements.

We are more than technical writers

I have always had an issue with the term “technical writer,” as it implies that all documentation consists ...