Documentation and Usability (The 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.
- 1 Introduction
- 2 Documentation: Why it’s worth the effort!
- 3 Lessons we should borrow from user designers
- 4 What does good documentation look like?
- 5 Creating a smooth getting started section
- 6 Creating helpful how-to examples
- 7 Creating handy reference guides
- 8 Creating clarifying code comments
- 9 Obtaining user feedback
- 10 Other helpful features
- 11 How to keep your documentation up to date
- About this course
- About the Authors
Jeff is a professor of Biostatistics and Oncology at the Johns Hopkins Bloomberg School of Public Health and co-director of the Johns Hopkins Data Science Lab. His group develops statistical methods, software, data resources, and data analyses that help people make sense of massive-scale genomic and biomedical data. As the co-director of the Johns Hopkins Data Science Lab he has helped to develop massive online open programs that have enrolled more than 8 million individuals and partnered with community-based non-profits to use data science education for economic and public health development. He is a Fellow of the American Statistical Association and Mortimer Spiegelman Award recipient.
Sarah Wheelan is an associate professor of Oncology and Molecular Biology and Genetics at the Johns Hopkins University School of Medicine, and has an appointment in the department of Biostatistics at the Johns Hopkins Bloomberg School of Public Health. She is a founder and co-director of the Center for Computational Genomics and a co-director of the Experimental and Computational Genomics Core.
The Leanpub 60-day 100% Happiness Guarantee
Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.