1
3 Comments

Is this worth solving? Automatically Track & Updating Images/Video in Technical Documents

So I've done a fair share of technical writing and have always been leary of adding screenshots because I have to then keep them up to date. Anyone else use MadCap Flare, StepShot Guides, or any other technical documentation platforms and embedded images or videos in them?

I'm now thinking of a better way to track the screenshots or videos used in documentation and helpfiles for software companies or even web-based applications.

How it would work is simple:

  1. Capture the screenshot using the tool and add it to your documentation or CMS. Tag it if needed or update the auto tags on capture.
  2. As your product was updated and UI changes are made, it would check weekly, monthly, or on each release schedule that you determine.
  3. Send you a report of out-of-sync images that should be updated.
  4. Provide version history so you can revert images and text if needed.

Is this an issue that you've seen and something you think worthwhile to solve?

on May 23, 2020
  1. 1

    Hey @Eharris04,

    Did you ever end up finding a tool for this?
    I've recently started a similar idea that automatically maintains both images and video, so super curious how you ended up solving this problem :)

  2. 1

    I have seen this issue, but I also know a few tools that solve this problem already.
    One of them is easyDITA.com, it is based on structured content unlike MadCap. You could publish the new changes everywhere the old content is used. It's pretty impressive!

    1. 1

      Thanks for the response. Will check that out and to your point, its not something accessible by MadCap. Maybe not a big enough market for it. Will keep searching.