Information in italics is intended to provide guidance while writing documentation and in general should be removed when a doc is at a v.1 stage.
The italics are suggestions to help guide what might go in a particular section. If you feel a section does not apply to the app or feature, please keep the section but just add that it does not apply.
If you feel it makes more sense for your documentation, you can move sections up and down.
Purpose
Describe the intended use of the app or part of FOLIO. This may be short or long, depending. You could describe things like common workflows that take place in the app; configuration options; whether an app has specific integrations with outside vendors.
A service point is FOLIO terminology for a library staff work location.
A service point is needed when you want to have at least one of the following services available:
- Patrons need to be able to request items to be delivered to that location for them;
- Patrons need to be able to request items to be held at that location for them;
- Patrons need to be able to check out items
- Patrons need to be able to check in items
- Items need to be ordered for that location;
- Items need to be put in transit to that location;
- Fines need to be charged for transactions that occur at that location;
There is no requirement that a service desk be a place that is providing service to patrons. In fact, libraries may find that it is helpful to establish internal service points for areas such as shelving, conservation, or collection development. It is really up to the individual library.
Permissions
Describe permissions that apply to the app or section you are outlining. Include default permissions and permission sets; dependencies that exist with permissions in other apps/parts of FOLIO.
Describe action-based permissions (if any) that apply to the app or section you are outlining, including permission dependencies and associated functional workflows.
Describe what each permission does, in language accessible to non-IT library staff.
UX/UI
Describe out of the box fields, including designed purpose, data requirements and validation, dependencies between fields.
Describe out of the box accordion menus, including purpose of the menus, customization options, and associated permission controls (if any)
Describe any workflows available through navigation menus, including purpose of the workflow, customization options, and associated permission controls.
Service point configuration options include:
- Name
- Code
- Discovery Display Name
- Description
- Shelving Lag Time
- Pickup Location (Yes/No)
- Print by Default options for Hold, Requests, Transit.
In addition, creating a Service Point will create an associated Calendar with the same name. The calendar is where you update opening and closing hours for that service point.
Searching
Describe pathways for searching in the app/feature through the UI.
Describe fields that are indexed in the back end specifically for searching
Describe any advanced searching features and how they would work.
Functional workflows
Describe available tasks that can be conducted in the app. To document those tasks, create a new page and link it to this page.
Describe action-based permissions that are connected to these functional workflows, if any.
- Creating a new Service Point
- Modifying a Service Point
- Adding a Service Point to a User Record
Reporting
Describe available in-app reports, including parameters for the reports, and associated permissions.
If there are developed LDP reports/queries for this app / area of FOLIO, describe those reports as well.
List any fields that may not be available in the LDP (e.g., for privacy reasons.)
There are no in-app reports available in this section of FOLIO.
Integrations
Describe any APIs that interact with the app. Provide links to the API / module information in Github.
Describe integrations that individual libraries may wish to develop for this app / area of FOLIO, if relevant.
If existing integrations have been developed by adopting libraries, provide links to the integration in Github or wherever the information can be found.
Describe and include any permanent links such as a link structure to records, searches, etc
Considerations for Implementation
Describe decisions or implications that need to be considered when implementing this feature.
Include topics such as order of operations during implementation or affects of implementing in a certain way.
- Every location that has physical items needs an associated primary service point in order to manage those items. Therefore, you should create your desired service points before creating your location hierarchy.
- Staff who use the Check-In and Check-Out app must have a service point assigned to them in their user record. Also Users? For Fines?