https://github.com/jhudsl/documentation_and_usability
This course covers the basics of creating documentation and tutorials to maximize the usability of informatics tools. It is meant for individuals developing tools for informatics.
https://github.com/jhudsl/documentation_and_usability
audience-software-developers category-software-dev documentation itn-course software-development usability user-feedback user-friendly
Last synced: 3 months ago
JSON representation
This course covers the basics of creating documentation and tutorials to maximize the usability of informatics tools. It is meant for individuals developing tools for informatics.
- Host: GitHub
- URL: https://github.com/jhudsl/documentation_and_usability
- Owner: jhudsl
- License: mit
- Created: 2021-04-08T17:33:44.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-10T18:59:55.000Z (5 months ago)
- Last Synced: 2025-01-10T19:44:08.437Z (5 months ago)
- Topics: audience-software-developers, category-software-dev, documentation, itn-course, software-development, usability, user-feedback, user-friendly
- Language: CSS
- Homepage: https://jhudatascience.org/Documentation_and_Usability/
- Size: 66.3 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
# Documentation and Usability Course
This is a bookdown based course to cover the basics of creating documentation and tutorials to maximize the usability of ITCR tools.
This course is a part of an [ITCR training series](https://www.itcrtraining.org/) and was in part created from [this github template](https://github.com/jhudsl/OTTR_Template).
You can see the [rendered course material here](https://jhudatascience.org/Documentation_and_Usability/introduction.html) or [on Leanpub here](https://leanpub.com/universities/courses/jhu/documentation_and_usability) or [on Coursera here](https://www.coursera.org/learn/documentation-usability-cancer-informatics).
This course guides you on how to make a nice documentation website using [this handy template](https://github.com/jhudsl/template-documentation) and its associated checklists!
Here's a preview of what that looks like
If you would like to contribute to this course material, take a look at the [CONTRIBUTING.md](./CONTRIBUTING.md) to get started and/or contact us on the [ITCR training website](https://www.itcrtraining.org/join-us).
## About this course
Informatics tools are designed to be used by a broad audience, everyone from entry level graduate students in biology to working professionals. Designing good user experiences can help increase usability of tools, but even for tools with necessarily complicated user interfaces, good documentation and tutorials can have an outsized impact on use and usability. This course is designed to teach principles of documentation and tutorials to tool developers in the ITCR and beyond.
## Learning Objectives
This course will demonstrate how to:
- Understand why usability and documentation is vital.
- Identify your user community.
- Build documentation and tutorials to maximize the usability of developed tools.
- Obtain feedback from your users.
## Encountering problems?
If you are encountering any problems with this course, please file a GitHub issue or fill out [this feedback form](https://forms.gle/bQHH3jPjMUj3gmcN7).