Documentation meeting 31 January 2024

Place

Video conference meeting using Jitsi at https://meet.jit.si/KohaDocumentationMeeting

We are using an (open source) video conference platform for the discussion part of this meeting. You don't have to turn your camera on if you prefer not to be seen; but if you are able to use a mic it should make our conversations a lot easier!
To join the meeting, click on the meeting link. If you are on a desktop computer, it will open in a browser window; no need to install anything. To join on a mobile device, you will need to download the Jitsi Meet app (from Google Play; from Apple Store).
Browsers will ask for permission to use video and audio devices: check or review these settings if you have audio or video issues.
Supported browsers | Mobile application

We will use the #koha IRC channel (IRC server irc.oftc.net) to record the meeting minutes, including #info and #action information. Feel free to login there too (if you don't have an IRC client you can use your web browser.)

Time

31 January 2024, 15:00 UTC (check the date and time in your timezone)

In attendance

8 people in total attended the meeting.

Updates

Review of action points

See previous meeting.
Martin to check with Jonathan what needs to be done for the one manual to be "live". DONE
Caroline to add CSS to the manual to make the version note green. DONE
Aude to update the ReStructuredText - Tips and Tricks so it includes versioning. DONE
Aude to update the Documentation - Content Development Guide so it includes what was agreed for versioning and the What's New page. DONE (as best I could...)
Aude to add future meetings to the Koha community calendar. DONE
Lucy and Aude to log a Documentation bug about expanding the Notices section. DONE - Bug 35855

What the team has been working on

Online Documentation workshops - Philip and Aude to report.
- Do we want to plan more?

Ongoing projects

Automated screenshots (Jonathan, Caroline) - Bug 34076
Re-organising the manual (David Nind) - Bug 32391

Documentation workflow: issues and ideas

What belongs where: this is the question of what belongs in the Manual and what should go in the Wiki (Aude on behalf of others)
- We have had several questions about this recently. It would be good to not only clarify the Manual / Wiki situation but also review what we want the Manual to feature more of in the future (e.g. examples, use cases, workflows...)
- For previous work on this, see Documentation style guide and Documentation - Content Development Guide.

Anything else

Articles about technical writing/documentation

These are for information only - feel free to add any articles/podcasts/videos that you come across that may be of interest to the documentation team. (If not useful, I won't include on future agendas.) (David Nind)

To Improve Translation, Wield the Period and the (Typographical) Bullet (5 April 2017, Content Rules): Maybe relevant for Koha documentation translation? Favourite quote: "German: Readable without eyeballs falling out." (with apologies to Katrin!).
Summary: A team from Google visited 11 countries to review translated Help Center articles and customer support emails with experts in each language. They wanted to know how to improve the English source content to get better translations. Recommendation: Use shorter sentences. Cut words and info that aren’t essential.

Reminders

Find bugs to document
- Bugzilla search for Keywords=Manual, Component=Documentation
- Bugs marked with Needs documenting status
How to edit the Manual

Next meeting

Wednesday 28 February, 19:00 UTC

Minutes