Human Essentials is an inventory management system for diaper, incontinence, and period-supply banks. It supports them in distributing to partners, tracking inventory, and reporting stats and analytics.
We need a maintainable user guide. Every so often we make a change that outdates our current documentation. (That just happened with Dashboard)
There is a balance to be struck between maintainablity, usefulness, and user-friendliness.
In its initial draft form, this is scoping the size of the effort, and sussing out what can be done. This may end up being scripts for videos, or it might stay in a markdown form, and we simply provide the link.
The tradeoffs on doing this as a markdown document are: maintainablility vs having a pretty format vs providing something for people who learn better from video than text. I don't think we have the manpower to maintain a full video tutorial over time, but it may be useful to provide a few demo type vids, especially around the partner experience, as the banks don't necessarially see that.
Using markdown makes it plausible to keep things up to date with changes to the UI.
Type of change
Documentation update
Include screenshots (before / after) for style changes, highlight edited element.-->
Description
We need a maintainable user guide. Every so often we make a change that outdates our current documentation. (That just happened with Dashboard)
There is a balance to be struck between maintainablity, usefulness, and user-friendliness.
In its initial draft form, this is scoping the size of the effort, and sussing out what can be done. This may end up being scripts for videos, or it might stay in a markdown form, and we simply provide the link.
The tradeoffs on doing this as a markdown document are: maintainablility vs having a pretty format vs providing something for people who learn better from video than text. I don't think we have the manpower to maintain a full video tutorial over time, but it may be useful to provide a few demo type vids, especially around the partner experience, as the banks don't necessarially see that.
Using markdown makes it plausible to keep things up to date with changes to the UI.
Type of change
Include screenshots (before / after) for style changes, highlight edited element.-->