Following the UX Survey results in which help documentation was highlighted as an area needing improvement, Mary and I talked with Moodle Senior UX designer, Hina, about what we could learn from the survey comments and where to start on making user documentation improvements.
We came up with a number of action points as follows:
- Improve each of the activity start pages, such as Assignment activity, to provide a quick guide for the activity, with more detailed information about settings etc. added to other activity pages.
- Make it clearer whether documentation applies to teachers or to admins by using the heading 'Site administration settings' on activity settings pages. Investigate adding a note at the top of pages with info for admins only.
- Go through all activity pages, checking the 'See also' links are up to date and making consistency improvements.
- Go through tracker issues labelled docs_required and add user documentation where necessary according to the Docs required issues process.
- Delete pages in the 3.9 docs for plugins not updated for 3.5 (see pages linking to the infobox plugin template for the list of plugin documentation pages).
- Identify areas of the documentation which need rewriting and reorganising to make the information easier to understand.
You may have noticed that Mary and I are already working on some of these action points. As always, if you can help in any way with the documentation it would be much appreciated! Many thanks to all our documentation contributors, including everyone helping with documentation in other languages.