Bug 23756 - [DOCS] [Omnibus] How-to and tutorial sections for the manual (including library workflows and use cases)
Summary: [DOCS] [Omnibus] How-to and tutorial sections for the manual (including libra...
Status: ASSIGNED
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement
Assignee: David Nind
QA Contact: Testopia
URL:
Keywords:
Depends on: 29712 32391
Blocks:
  Show dependency treegraph
 
Reported: 2019-10-04 22:56 UTC by Christopher Brannon
Modified: 2025-06-25 03:36 UTC (History)
3 users (show)

See Also:
GIT URL:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
Circulation function:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Christopher Brannon 2019-10-04 22:56:40 UTC
Wondering if the documentation should include workflow examples for different tasks.  I know how different each library can be with their workflows, but workflows seem to be a common topic, and there are multiple ways to approach different tasks.
Comment 1 Katrin Fischer 2019-10-14 22:12:11 UTC
Hi Christopher, I like the idea. Maybe something for the docs meeting as well?
Comment 2 Aude Charillon 2023-12-11 11:34:04 UTC
Linked to the omnibus bug regarding a content and style guide for the Manual (hopefully I've done that correctly!)

Workflows have been mentioned by other members of the Documentation team and we want to try and accommodate those. We will be discussing in upcoming meetings how to do that. Everyone can take part in the discussions; see https://wiki.koha-community.org/wiki/Category:Documentation_IRC_Meetings for the next meeting dates.
Comment 3 David Nind 2025-06-25 03:36:48 UTC
I've repurposed this bug for adding "How-tos" and "Tutorial" sections to the manual, which I think fits with what is described here.

Once we have brainstormed some ideas on potential topics for how-tos/tutorials/use cases/library workflows at a documentation meeting (it has been on the agenda for some time), I'll create separate bugs for each topic. 

But feel free to add any ideas you have as a comment on this bug as well!

Hopefully, we can then get "someone" to write the content!

We intend to use these Good Docs Project guidelines and templates:

* How-to: Guidelines - https://www.thegooddocsproject.dev/template/how-to) + Markdown template - https://gitlab.com/tgdp/templates/-/blob/main/how-to/template_how-to.md

* Tutorial: Guidelines - https://www.thegooddocsproject.dev/template/tutorial) + Markdown template - https://gitlab.com/tgdp/templates/-/blob/main/tutorial/template_tutorial.md

Some topics suggested so far:
1. SIP: SIP2SortBinMapping
2. Closing a library
3. Koha installation checklist (see the koha-US checklist)