During the months of February and March, I continued working on documentation for my own project. There were a few factors that caused challenges and new considerations that I had to make in the documentation I had already written.
With Mark’s MDI app having an installable version, the majority of the documentation written for it has become obsolete. However, neither this new version or the original version were tested on machines other than Mark’s or mine. The original version was causing some issues on other machines and could not run, while the new version has yet to be installed on another machine. This has left me in an odd position on what to do with the old documentation. I feel the best course of action would be to keep the old documentation and download link to the original version of MDI in the document, but note that the information is obsolete and only needed as a backup plan if the new version does not work.
In March, Kate was very helpful and looked over the documentation I had written so far. I tried to be as detailed as I could with terms and concepts that went past the knowledge I expected from the people not involved in the techinical elements of the website, but Kate pointed out some places that were unclear. This was mainly in concepts I did not explain enough, or misuse of some terms. Through these comments, I also realized there was an entire section I did not revisit in months. Before the my documentation goals pivoted from explaining CollectionBuilder to outlining the entire TDPS Archive workflow, I did start on a section about the configuration files and how they related to our project. At this point in the project, where changes to these files are largely unnecessary, I briefly considered removing this documentation. However, I think it’s best to leave it in case there is interest in making edits to configuration for searching and browsing. Much of the information is comparable one-to-one with what is available on CollectionBuilder’s official documentation, so I feel in some cases it would be better to redirect to that website.