Week 9 – Documentation

In order to create good documentation, the writer will need to describe each step that they took with a pretty notable amount of detail. It may also be necessary to add a visual aid, such as a video or images to the documentation in order to show certain steps that need to be done. For my own Vivero project, my project lead and I will need to create documentation on how to upload articles to our database, and how to extract metadata from these articles. However, I also would not be surprised if eventually we will have to provide more documentation in order to effectively communicate how to navigate our digital project. In order to make this happen, I will make sure to communicate often with my project lead when technical steps are implemented, and I will also keep a document that lists the steps taken for what is necessary.

Leave a Reply

Your email address will not be published. Required fields are marked *