Feature: Improved artifact documentation
In a conversation with Pitt's Digital Scholarship Services group, they suggested two related features.
Administrator / Archivists Notes Section
We could provide the ability for archivists and administrators to make notes on an artifact's use and special considerations that are not noted in the official artifact documentation. This could include notes on successor objects or special considerations on object inputs.
We could temporarily support this by having users include such documentation in the object's repository, but it would be an improvement to highlight this documentation specially in our front-end. This documentation would also need to be tied to an object's version, which leads me to believe it belongs as a part of the repository at some level.
If resources and dependencies heavily influence the behavior of an artifact, it might be useful for the archivist's notes section to reference different versioned documentation within the system. This leads to the second suggestion.
Indexed and Searchable Artifact Documentation
The DSS group indicated that it would be beneficial to be able to search artifact documentation across the object repository. We do not currently index documentation, and in order to do so we would need a way to denote what files in the repository count as documentation and how to read any formats marked.
Design
TBD