[Koha] Documentation - Automated screenshots can still be the way to go!

[Charillon, Aude]

Hello,

I know some lucky people are on their way to KohaCon - but for the
rest of us, it's just any other Friday! And now sounds as good a time
as any for the Documentation team to share an update on the automated
screenshots project. Read on for more information - and a cute animal
as a reward!

### Automated what?

A year and a half ago, the Documentation team and Jonathan Druart
started looking into the possibility to automate the update of the
screenshots used in the Koha Manual. The benefits would be:
- a more up-to-date Manual for library teams. Currently, among our
1,600+ screenshots we still have many from pre-22.11 Koha (before the
staff interface became green);
- a gain of time for the Documentation team;
- the possibility to have screenshots in the language of the Manual.
Currently, the text of the Manual is translated but the screenshots
are the same, making them less useful for librarians who don't speak
English.

###  What's happened so far
Skip this section if you're not interested in the full project history!

Spring 2023: Jonathan Druart starts looking at (new) ways to automate
updating screenshots - see bug 24076
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34076

August 2023: Jonathan presents his work so far at KohaCon23 (talk
recording https://youtu.be/16uDrqulL5E).

September 2023: Caroline Cyr La Rose emails this list to ask for help
with analysing screenshots
(https://lists.katipo.co.nz/pipermail/koha/2023-September/060003.html).
We wanted to find out what steps are needed in Koha before the
screenshot can be taken - information which the scripts that generate
screenshots need. Big thanks to everyone who helped! We analysed 187
images over the next few months.

April 2024: at the Marseille Hackfest, Jonathan presents the new
website he created for the Documentation team to analyse screenshots.
The website allows him to more easily create scripts to generate the
screenshots. The Documentation team can check on the website what the
generated screenshots look like.

Today: I am writing again asking for help to analyse more screenshots!

### Next steps

We have been experimenting, but we still need to experiment more
before we can go ahead and use automatically-generated screenshots in
the manual.

We have been targeting screenshots that would be easy to generate
automatically. We need more of those to be analysed - and we need your
help!

If you are interested in participating, please read the guidelines on
how to analyse screenshots at: https://link.infini.fr/_Nzb3p-w
The steps summarised:
- Make sure you have a login to Jonathan's website (request one if not).
- Pick a screenshot to analyse.
- Find on your Koha system what the screenshot shows.
- Add the details (page, element selector, workflow) to the screenshot
page on Jonathan's website.
- Assess the difficulty, as explained in the guidelines.
- Save. Pick another screenshot to analyse!

If you have any questions, please feel free to contact me - either by
email or, even better, on the Koha community Mattermost chat. You can
also drop a line in the Mattermost Documentation channel :-) If there
is interest, we could organise an online workshop to get started with
analysing screenshots together.

Thanks,

Aude
On behalf of the Koha Documentation team

⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⡠⠔⠚⠋⢉⣉⣉⣍⣉⠉⠙⠒⠦⢄⡀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⡠⠊⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣀⠤⠖⠛⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⡰⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⠞⠁⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢰⠃⠀⠀⠀⠀⠀⠀⠀
⠀⠀⢰⠚⠓⡎⠑⢦⠀⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠸⡤⠚⡇⠀⠈⣧⣼⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠳⣄⠀⠀⠀⠀⠀⠀
⠀⢀⠎⠀⠀⠀⠀⠀⠈⠀⠙⣄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠓⢄⠀⠀⠀⠀
⠀⢸⠀⠠⣶⡄⠀⠀⠀⠀⠀⠈⠉⠉⠒⠢⢤⣀⠀⠀⠀⠀⠀⠀⠀⠑⣄⠀⠀
⠀⡿⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠢⢄⠈⠓⢄⠀⠀⠀⠀⠀⠀⠈⣆⠀
⠀⢿⣤⡀⣀⣤⣀⡤⠀⠀⠀⠀⠀⠀⠀⠀⠀⠙⢆⠈⢧⠀⠀⠀⠀⠀⠀⠸⡀
⡴⠚⢻⣍⣡⠤⠚⠁⠀⠀⠀⠀⢀⡴⠊⠀⠀⠀⠈⠆⠈⡇⠀⠀⠀⠀⠀⠀⡇
⡇⠀⢻⣀⠤⠤⠤⣀⣀⣠⠞⢠⠋⠀⠀⠀⠀⠀⠀⠀⠀⡇⠀⠀⠀⠀⠀⠀⠇
⠹⣄⠔⠁⠀⠀⠀⠀⢠⠛⠦⡎⠀⠀⠀⠀⠀⠀⠀⠀⢰⠇⠀⠀⠀⠀⠀⡸⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠘⡄⠀⢳⠀⠀⠀⠀⠀⠀⠀⢠⠏⠀⠀⠀⠀⠀⡰⠁⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠘⢆⠈⠳⣄⠀⠀⠀⠀⡰⠃⠀⠀⠀⠀⣠⠞⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⣀⣀⣀⣑⣄⣈⣣⡀⠀⡞⠀⠀⢀⣠⠴⠊⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠰⠥⠤⢴⣉⣁⣀⣀⡤⠤⠼⠒⠉⠁⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
(Totally copying Caroline's tricks! ^^)

Aude Charillon
Librarian | Customer Services Consultant
PTFS Europe
aude.charillon at ptfs-europe.com