...
- List all available out of the box fields;
- Define the purpose of those fields;
- Define any data requirements for those fields, and where that data should be validated (in UI, underlying module, bulk loading, etc.)
- Describe the dependencies between fields
- Define customization options for those fields (if any)
- List all available out of the box accordion menus;
- Define the purpose of those menus;
- Define customization options for those menus (if any)
...
Several different types of functional library workflows live in the users app Users App or interact heavily with the app, including creating new patrons, fee/fine management, and anonymizing / scrubbing patron information.
Documentation for functional workflows in the Users app App should:
- Describe all available functional tasks that can be conducted in the app;
- Describe all action-based permissions that are available for control of the functional workflow, including what that action-based permission does in language accessible to a FOLIO app user
- ...
...
- Describe all available in-app reports, including parameters and permissions controlling access to the reports;
- Describe all available LDP reports, including parameters and permissions controlling access to the reports;
- Describe available customization options for reports, if they are standard to a FOLIO installation
- List all fields that are (not) available in LDP, e.g. for privacy reasons
- .....
Integrations
Many libraries (especially initial adopters of FOLIO) will need to integrate outside data sources with their users app, to add and delete users based on centralized identity management.
...
- List all APIs that interact with the Users app App and may be used in an integration workflow;
- Provide examples of common API calls (including code as relevant) to demonstrate how an integration works;
- .....
...
We would expect technical reference documentation to be produced by FOLIO developers, but it's important to recognize that that documentation is not sufficient for supporting the broader community.
The Users app App will need:
- Reference documentation (much of which is outlined above) to fully understand the function of the app;
- Tutorials / getting started guides for new staff users and new institutions, including how to support integrations with external data sources;
- How-to guides to support common workflows and tasks that library staff need to do within the app.
...