After both reading and writing documentation, what do you think is necessary to create good documentation? What documentation will you and your project lead need to create for your Vivero project – and what steps do you need to take to make this happen?

I think good documentation needs to be specific. This means citing yourself and/or others as the creators of that documentation, the day the documentation was last updated, writing versions of programs, locating where elements are on a crowded page, photos during the step-by-step process, defining terms that may be confusing to those first learning, and subheadings for different kinds of steps. In particular, defining terms I have found to be kind of annoying to do. However, I believe that a part of that irritation is that I don’t actually know what the word means. Documentation is not only good for instruction, but it’s good for the maker of the documentation to reinforce what they actually know. I ran into this issue trying to define what a block editor was!

The kind of documentation I’m currently doing is not actually documentation that will necessarily translate to the public-facing thesaurus. I’m trying things out, as a trilingual thesaurus doesn’t have a tool that directly maps onto the project exactly. I’ve opted to just document all the glossary plugins I’m trying just to ensure my familiarity with them. Where do the tools fall flat? Where are there spaces for opportunity?