Future User Doc projects
Issue | Description of problem and possible solutions | Pages involved | Notes |
|---|---|---|---|
Create list of fields included in AS reports | While a description of the type of information is included in descriptions of existing reports, there isn't a comprehensive list of the fields data is pulled from to create those reports. Project would involve running reports and determining which fields were used to create the report and build a list/chart of the fields in each report. |
| |
Create documentation for the Public User Interface | There currently isn't any documentation dedicated to the PUI. Would need to determine what needs to be documented and create the documentation. |
|
|
Create documentation for spreadsheet templates | Create documentation for spreadsheet templates that is independent of importing and exporting documentation. This will more easily facilitate updates to both sets of documentation. Templates are updated independently of new features/releases/etc. The documentation quickly becomes out of date when integrated with other functionality and creates more work to version pages. |
|
|
Create documentation for the config file | Currently, there is nothing in the User Manual to describe the config file at a higher level. This was acknowledged at a collaborative meeting with the Tech Docs sub-team in January 2026. Consider describing in the User Manual the items that users/hosts can change in config file to improve institutions' experiences. This could be a collaborative project with the Tech Docs and Usability sub-teams. |
|
|
Document which field do and don't publish to the PUI | Documentation doesn't exist concerning which fields in the Staff User Interface can be published to the PUI. Group would need to test functionality and create documentation. |
| The project began in the 2022-2023 term and was completed in the 2023-2024 term. (Link to spreadsheet) |
Consolidate duplicate pages into a single higher level page | There are currently multiple pages documenting the same function, which need to be edited separately, causing them to get out of synch and requiring extra work to edit. Proposed solution: move instructions out of current sections (example: Accessions, Resources) and make a single page at the same level as the current parent page. Some of the duplicate pages are listed in the next column, but more analysis is need to identify pages to merge and assess the impact of merging pages. Also need to determine process for merging and/or deleting pages and if User Doc team members have permission to do the work. | User Defined Fields - Accessions User Defined Fields - Resources Dates Sub-Record - Digital Objects Extents Sub-Record - Accessions Extents Sub-Record - Resources Extents Sub-Record - Digital Objects Subject Links - Digital Objects External Documents Sub-Record - Accessions External Documents Sub-Record - Resources External Documents Sub-Record - Digital Objects Rights Statements Sub-Record (v2.1.0) - Accessions Rights Statements Sub-Record (as of v2.1.0) - Resources Rights Statements Sub-Record (v2.1.0) - Digital Objects Instances Sub-Record (as of v1.5.0) - Accessions Instances Sub-Record (as of v1.5.0) - Resources Locations (as of v1.5.0) - Accessions Deaccessions Sub-Record - Resources Collection Management Sub-Record - Accessions Collection Management Sub-Record - Resources Collection Management Sub-Record - Digital Objects Classifications Sub-Record - Accessions Classifications Sub-Record - Resources Importing Digital Object Data from a CSV file - Digital Objects Importing Digital Object Data from a CSV File (Importing Data) - Importing and Exporting Data Exporting Digital Object Records in MODS, METS, or DC (Dublin Core) Formats - Importing and Exporting Data Exporting Digital Object Records in MODS, METS, or DC (Dublin Core) Format - Managing Digital Objects
| This project was completed during the 2024-2025 term and a new page was added to the User Manual for Sub-Records Shared Across Record Types. |