See also an issue and PLIP that address this topic more broadly.
- Automate screenshots and videos · Issue #1611 · plone/documentation · GitHub
- Create User Manual with screenshots and videos for Plone 6 · Issue #3987 · plone/Products.CMFPlone · GitHub
There's a couple of points of emphasis that members of the Write the Docs community have made since I created those items.
- If your UI requires screenshots and videos to explain how to use it, it's probably a shitty UI. Use them sparingly, if it all. Narrative text is much preferable and easier to update.
- Screenshots aren't translatable. Text is translatable.
- Images, videos, and other large data files such as databases, MLMs, and AI data, should not be put into version control of a repository that is used primarily for development due to performance problems with git. Only references to media should be in such a repo. We've seen this in Volto, where media needlessly bloats its repo for developers. I learned this about 15 years ago while working on a media-heavy project for tree identification. Instead use something like git-lfs or DVC as an extension of git, and store your large data files in a compatible cloud storage.