User Story #10193 (closed)
Opened 11 years ago
Closed 11 years ago
Improve user documentation
Reported by: | hflynn | Owned by: | hflynn |
---|---|---|---|
Priority: | critical | Milestone: | OMERO-4.4.7 |
Component: | Documentation | Keywords: | n.a. |
Cc: | jburel, jamoore, rkferguson | Story Points: | n.a. |
Sprint: | n.a. | Importance: | n.a. |
Total Remaining Time: | n.a. | Estimated Remaining Time: | n.a. |
Description
The current user documentation is not very user-friendly.
Possible improvements:
- add training materials to main user docs
- redo user index page - including clearer divisions between what is nice simple functionality in Omero.insight or Omero.web and the more complex stuff so beginner users aren't put off by looking at advanced stuff, and titles/links which focus on 'how to...'
- better connections between user docs and features page and demo movies
- New overview which really sells what we are doing, and for example, why users should choose omero rather than just using ImageJ etc
Change History (7)
comment:1 Changed 11 years ago by rkferguson
comment:2 Changed 11 years ago by hflynn
Thanks Gus. I've made you a ticket for getting the training materials into sphinx (#10194) - once this is sorted we should probably have a chat about structuring the index and rewriting the overview.
comment:3 Changed 11 years ago by hflynn
- Type changed from Requirement to User Story
comment:4 Changed 11 years ago by agilo
- Status changed from new to accepted
Updated status, related task in progress
comment:5 Changed 11 years ago by hflynn
Training chapters are now replacing out of date tutorials, new index page with more explanation is live, and I've now updated both the 'About Omero' and the 'Features' page on Plone to include more links into the docs. Once @rkferguson updates the Managing Data guide as per the linked task, I'm happy to close this ticket too.
comment:6 Changed 11 years ago by rkferguson
Will do this shortly.
comment:7 Changed 11 years ago by hflynn
- Resolution set to fixed
- Status changed from accepted to closed
Final task completed, closing ticket as further work will be covered by usual workflow tickets now overhaul is complete.
Happy to help with this if you want to do a joint approach.