4/6/2025
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 that writing in both very specific, but very simply language is most necessary for creating good documentation–assuming that your reader will be able to follow along, but not needlessly complicating the steps that it takes to complete a process. I think the documentation that will most help with my project right now, and perhaps something I should write, would be to complete detailed documentation on how to access the Virtual Tithead database, as a lack of collected and specific enough documentation on that has cause some little hiccups in the flow of work (Nothing major! I’m just lost in Finder files). I also think a really important thing about documentation, and specifically about the documentation of the project I am working on, is to make sure it is all collected in a place where it can be easily accessed. Even if you create spectacular documentation, it can’t help anyone if it can’t be found. I think that the steps I will need to take to improve the documentation for the Virtual Tithead Project is to work through accessing the database step by step, writing down the documentation as I go, and ensuring it can be found with relative ease for whichever fellow works next on the project!