- After both reading and writing documentation, what do you think is necessary to create good documentation?
I think a thorough understanding of the tool is crucial when creating documentation. You can’t easily and concisely explain something without familiarity with the tool, but documentation also requires effective comprehension and writing skills to communicate how to use the tool clearly. You also need the ability to put yourself in a new user’s shoes or have users provide feedback on the documentation, preferably both.
- 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?
My project this semester will need documentation on the creation of new anchor tags, formatting definition entries, and guidelines for the data entry of definitions, including reliable sources for definitions.