Owen,
A number of years ago I saw this video https://www.youtube.com/watch?v=UMnZiTL0tUc about doing pixel diffs (or pdiff as they call it) for UI elements on a web application. It sounds like it might be part of the answer you are looking for. Something like, run pdiff on all pages that are documented, if different run script to capture images again, and have user/developer check changes.
I don't know of an automated way to generate user documentation with screenshots, but it sounds like it might be useful.
-----Original Message-----
From: Code for Libraries [mailto:[log in to unmask]] On Behalf Of Owen Stephens
Sent: Monday, January 26, 2015 6:38 AM
To: [log in to unmask]
Subject: [CODE4LIB] Automatically updating documentation with screenshots
I work on a web application and when we release a new version there are often updates to make to existing user documentation - especially screenshots where unrelated changes (e.g. the addition of a new top level menu item) can make whole sets of screenshots desirable across all the documentation.
I'm looking at whether we could automate the generation of screenshots somehow which has taken me into documentation tools such as Sphinx [http://sphinx-doc.org] and Dexy [http://dexy.it]. However, ideally I want something simple enough for the application support staff to be able to use.
Anyone done/tried anything like this?
Cheers
Owen
Owen Stephens
Owen Stephens Consulting
Web: http://www.ostephens.com
Email: [log in to unmask]
Telephone: 0121 288 6936
|