"Notes on functionality" project

(1) New feature or significant enhancement

• Highlight only the most important. 3-4 at most?

• Include the info listed below for each one.

• Brief summary

• Use non-technical, natural language.

Reporting errors and warnings

Errors encountered during a bulk edit job are now separated from warnings. Errors are reported if the records cannot be uniquely identified records for a bulk editing job or if update of a record fails. Existing data issues that do not affect bulk edit execution are reported as warnings.

• Demos

• Screenshots are super helpful and encouraged!

• Demo videos are even more helpful, but they are more time-intensive to produce. So these are appreciated but not expected.

• Notes

  • Scope

  • Permissions

  • Known issues

• Cover each of these three areas if possible or applicable.

• Scope → what is in and out of scope for the feature, any necessary context

• Permissions --> Updates or changes to permissions that are necessary for the new feature, if applicable

• Known issues → Any limitations or bugs that users should be aware of

• Scope

  • The goal of the version history is to track field-level changes (added, removed, edited) in the record, specify the user who made those changes*, and the ability to drill down into a detailed view of the values changed.

    *Note: The feature itself will be controlled by a flag so that changes and any user information won’t be tracked.

  • Open

    

• Permissions

  • If a user has permissions to view Inventory and/or MARC authority records, that user will have the ability to view the Version history pane of the corresponding records.

• Known issues

  • Very large ledgers (more than 300 associated funds) may encounter performance issues when using the batch allocation tool, and ledgers with more than 800 associated funds cause FOLIO to freeze up. This will be mitigated in a future service patch, however, libraries wishing to use the batch allocation tool may wish to limit the number of funds associated with a given ledger.

• Documentation

  • Jiras

  • Relevant recordings, sprint demo videos, slide decks, etc.

  • Docs.folio.org pages

  • Relevant wiki pages

• Doesn’t need to be comprehensive

• Important to separate out each category of documentation

• Jiras are the most important; include the other types if useful

Enhancements & bug fixes

• In the interest of time, these should just be brief lists with links to Jiras

• No additional summaries or details needed

Open

Bulk Edit