Search icon
Arrow left icon
All Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Newsletters
Free Learning
Arrow right icon
Technical Writing for Software Developers

You're reading from  Technical Writing for Software Developers

Product type Book
Published in Mar 2024
Publisher Packt
ISBN-13 9781835080405
Pages 166 pages
Edition 1st Edition
Languages
Author (1):
Chris Chinchilla Chris Chinchilla
Profile icon Chris Chinchilla

Table of Contents (12) Chapters

Preface 1. Chapter 1: The Why, Who, and How of Tech Writing 2. Chapter 2: Understanding Different Types of Documentation in Software Development 3. Chapter 3: Language and the Fundamental Mechanics of Explaining 4. Chapter 4: Page Structure and How It Aids Reading 5. Chapter 5: The Technical Writing Process 6. Chapter 6: Selecting the Right Tools for Efficient Documentation Creation 7. Chapter 7: Handling Other Content Types for Comprehensive Documentation 8. Chapter 8: Collaborative Workflows with Automated Documentation Processes 9. Chapter 9: Opportunities to Enhance Documentation with AI Tools 10. Index 11. Other Books You May Enjoy

Animated GIFs and videos

A series of images can show the steps someone needs to follow to accomplish a task, but sometimes, it may be easier to show the steps directly. There is also evidence to show that newer learners tend to prefer learning by visual means instead of text. So, for different reasons, a video of some form may be a better method for explaining a concept.

Animated graphical interchange format (GIFs) and videos share many of the same positives and negatives of images and add more besides. Here is a summary of things to consider.

On the positive side, videos and animated GIFs have the following advantages, they:

  • Can show someone the steps to follow and the intended outcome directly
  • Give someone the chance to follow along, pausing the video as they do
  • Allow for some incidental and anecdotal practical advice while explaining a concept
  • Depending on how you create and host a video, it can be more accessible than text with autogenerated transcripts...
lock icon The rest of the chapter is locked
Register for a free Packt account to unlock a world of extra content!
A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.
Unlock this book and the full library FREE for 7 days
Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of
Renews at $15.99/month. Cancel anytime}