| Documentation WG updates | | Work is continuing! Goal is to have a "complete" set of docs for apps in Iris. Circulation Documentation - Needs Some broad groups of documentation that I've identified for work include: - fees/fines and blocks
- Has some existing documentation Settings - Users
- Need to write some basic fee/fine docs:
- Viewing a patron's fee/fine history
- Waiving a fee/fine - full waive, partial waive
- Refunding a fee/fine - full waive, partial waive
- Accepting payment for a fee/fine - full/partial
- Need to write some basic docs on blocks
- manual blocks
- automated item blocks
- automated patron blocks
- Need to write more detailed documentation focused on learning the system
- Notices
- has existing documentation from Fameflower as a base - Patron Notices
- we need to add troubleshooting documentation and answer the questions we identified:
- How do scheduled notices work when they run on day intervals
- How do scheduled notices work when they run on hour or minute intervals
- What triggers different kinds of notices – all of the different kinds of patron notices available
- How do staff slips work? how do you format them?
- Tips for troubleshooting patron notice delivery
- Tips for troubleshooting staff slips
- circulation rules & policies
- Basic documentation already exists - https://github.com/folio-org/mod-circulation/blob/master/doc/circulationrules.md
- what happens when circulation rules change after an item has been checked out? what happens when item information changes after an item has been checked out? what happens when patron information changes after an item has been checked out?
- Things to consider when deciding how to write circulation rules
- How the fallback policy works
- How prioritization works
- Special characters and indentations
- Sample circulation rule sets from adopters
I'm glad to work on each of these areas and help shepherd it through, but really need to have help writing these. This is a great opportunity to force yourself to learn how this stuff works, too. |
|