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 the key difference between good documentation and normal documentation is assuming that your reader is starting from scratch, with no (or the bare minimum) background knowledge. This way, you’re being very thorough in the instructions you leave for them and what steps exactly you took to achieve something. It also makes it much easier to work on something after an extended break or after someone else has worked on it. What might be obvious to someone who has a lot of experience with a tool might not be to someone who has just been onboarded to a project.
For the Grinnell Architecture project we will likely need to create site documentation so that the aesthetic of the site is easily customizable. Since this will be a public architecture-guide style site, it is important that it is easy to make changes to enhance the visuals of the site. We will also need documentation for how to upload content on to the site (for other users, say students) since the class that produced the posters might be taught again in the future. Whoever works on the site in the future will need to know how that process works so new posters can be formatted in line with the existing ones.
0 Comments