I'm looking for a tool/software to keep software documentation for a website project always up-to-date.

Especially the images in the documentation, e.g. explaining user masks etc. gets out of sync and someone (at the lower end of the payrange) needs to update those images according to the newest UI.

Is there a way to automate the extraction of certain website parts (maybe based on html tags/Ids e.g. of a div with id="user-create-modal") and to embed an image accordingly named "user-create-modal.png" into our online documentation with a link to that ever-updated url?

  • It heavily depends on the website design (especially parallax scrolling) and the size of the screenshot. Jun 20 '16 at 18:26

If the images that you need to reference are also always on-line the easiest is to actually link to them where they live, (with the owners permission of course), then when they are loaded as a part of your documentation they will always be current.

Alternatively, you can easily use python:

  • the requests library to fetch the images,
  • then PIL, or Pillow, to resize/convert/etc. the image(s) if required - even annotate them.

The python script could be run on a regular basis and check if the image(s) have changed and if they have either upload the revised images automatically or, better, prompt for a review - if the images at the other location have been changed inappropriately you do not wish to be uploading them to your online documentation.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.