We may earn an affiliate commission when you visit our partners.
Documentation and Usability for Cancer Informatics
Candace Savonen, MS
Candace Savonen, MS
Introduction:
Read more
Introduction:
Read more
Introduction:
Cancer datasets are plentiful, complicated, and hold information that may be critical for the next research advancements. In order to use these data to their full potential, researchers are dependent on the specialized data tools that are continually being published and developed. Bioinformatics tools can often be unfriendly to their users, who often have little to no background in programming (Bolchini et al. 2008). The usability and quality of the documentation of a tool can be a major factor in how efficiently a researcher is able to obtain useful findings for the next steps of their research.
Increasing the usability and quality of documentation for a tool is not only helpful for the researcher users, but also for the developers themselves – the many hours of work put into the product will have a higher impact if the tool is usable by the target user community. 70% of bioinformatics tools surveyed by Duck et al. (2016) were not reused beyond their introductory publication. Even the most well-programmed tool will be overlooked by the user community if there is little to no user-friendly documentation or if they were not designed with the user in mind.
Target Audience:
The course is intended for cancer informatics tool developers, particularly those creating tools as a part of the Informatics Technology Cancer Research.
Learning Objectives:
1. Understanding why usability and documentation is vital
2. Identifying your user community
3. Building documentation and tutorials to maximize the usability of developed tools
4. Obtaining feedback from your users
Curriculum:
This course will demonstrate how to: Understanding why usability and documentation is vital, Identifying your user community, Building documentation and tutorials to maximize the usability of developed tools, Obtaining feedback from your users
The course includes a hands-on exercises with templates for building documentation and tutorials for cancer informatics tools. Individuals who take this course are encouraged to use these templates as they follow along with the course material to help increase the usability of their informatics tool.
This course is part of a series of courses for the Informatics Technology for Cancer Research (ITCR) called the Informatics Technology for Cancer Research Education Resource. This material was created by the ITCR Training Network (ITN) which is a collaborative effort of researchers around the United States to support cancer informatics and data science training through resources, technology, and events. This initiative is funded by the following grant: National Cancer Institute (NCI) UE5 CA254170. Our courses feature tools developed by ITCR Investigators and make it easier for principal investigators, scientists, and analysts to integrate cancer informatics into their workflows. Please see our website at www.itcrtraining.org for more information.
Register for this course and see more details by visiting:
OpenCourser.com/course/9xduap/documentation
What's inside
Syllabus
Welcome
In this first section, we will discuss the goals of this course and why documentation is so vital to cancer research.
Lessons we should borrow from user designers
Read more
Syllabus
Welcome
In this first section, we will discuss the goals of this course and why documentation is so vital to cancer research.
Lessons we should borrow from user designers
Read more
In this section, we will discuss broader concepts of usability from the field of user design and what that might mean for informatics tool development.
What does good documentation look like?
In this section, we will discuss the larger components that make up good documentation that will enhance usability of a tool.
Creating a smooth getting started section
In this section we will discuss how to make a getting started section that nicely eases a user into the concepts and workings of a tool.
Creating helpful how-to examples
In this section we will discuss the goals and components of how-to examples that will expand your user's understanding and familiarity with your tool.
Creating handy reference guides
In this section we will discuss what aspects of reference guides can help users troubleshoot and answer questions that arise.
Creating clarifying code comments
In this section we will discuss how well-documented code is a part of a tool with high usability.
Obtaining user feedback
In this section we will discuss how to obtain user feedback to enhance the usability of your tool.
Other helpful features
In this section we discuss other helpful features that you may also want to consider adding to your tool documentation to increase usability.
How to keep your documentation up-to-date
In this section we discuss how to keep your documentation up to date.
Good to know
Good to know
Know what's good ,
what to watch for , and
possible dealbreakers
Teaches how to improve documentation of bioinformatics tools for cancer research
Covers broader concepts of usability from the field of user design and what that might mean for informatics tool development
Develops higher quality documentation that will enhance usability of a tool
Emphasizes the importance of identifying your user community
Provides guidance on obtaining feedback from your users to enhance the usability of your tool
Offers hands-on exercises with templates for building documentation and tutorials for cancer informatics tools
Save this course
Save Documentation and Usability for Cancer Informatics to your list so you can find it easily later:
Save
Save
Activities
Be better prepared
before
your course. Deepen your understanding
during
and
after
it. Supplement your coursework and achieve mastery of the topics covered
in Documentation and Usability for Cancer Informatics with these
activities:
Review industry standards for documentation
Show steps
Familiarize yourself with industry standards and guidelines for documentation to ensure your work meets professional expectations.
Browse courses on
Best Practices
Show steps
-
Identify relevant documentation standards in your industry
-
Review the key principles and requirements of these standards
Compile a collection of resources on documentation and usability
Show steps
Gather and organize a collection of useful articles, tutorials, and other resources related to tool documentation and usability.
Browse courses on
Information Management
Show steps
-
Identify reputable sources of information
-
Search for relevant content on topics such as documentation best practices and user experience
-
Organize and categorize the collected resources
Join a study group to discuss documentation and usability
Show steps
Connect with other students in the course to discuss topics related to tool usability and documentation, exchange ideas, and provide feedback.
Browse courses on
Peer Support
Show steps
-
Find a study group or create your own
-
Establish regular meeting times and agendas
-
Discuss topics related to course content and explore different perspectives
Four other activities
Expand to see all activities and additional details
Show all seven activities
Explore examples of well-documented tools
Show steps
Review examples of well-documented tools to gain inspiration and ideas for your own documentation.
Browse courses on
User Experience
Show steps
-
Identify tools in your field with a reputation for usability
-
Examine their documentation for features such as clarity, organization, and accessibility
Create an infographic about tool usability
Show steps
Create an infographic that summarizes the key principles of tool usability to reinforce your understanding of the first section of the course.
Browse courses on
Informatics
Show steps
-
Research the principles of tool usability
-
Create a draft of the infographic using a template or design software
-
Revise and refine the infographic based on feedback from peers or instructors
Build mock documentation for a tool
Show steps
Develop a mock documentation page for a hypothetical tool based on the concepts you learned in the section on documentation.
Browse courses on
Informatics
Show steps
-
Identify the target audience for the tool
-
Determine the purpose and scope of the documentation
-
Write clear and concise content using appropriate formatting
-
Test the documentation to ensure it meets the needs of users
Develop a documentation plan for an existing tool
Show steps
Select an existing tool that lacks adequate documentation and create a plan to develop comprehensive and user-friendly documentation.
Browse courses on
Project Management
Show steps
-
Identify the tool and its target audience
-
Analyze the existing documentation and identify areas for improvement
-
Develop a plan for creating new or revising existing documentation
-
Implement the documentation plan and test its effectiveness
Review industry standards for documentation
Show steps
Familiarize yourself with industry standards and guidelines for documentation to ensure your work meets professional expectations.
Browse courses on
Best Practices
Show steps
Show steps
Show steps
- Identify relevant documentation standards in your industry
- Review the key principles and requirements of these standards
Compile a collection of resources on documentation and usability
Show steps
Gather and organize a collection of useful articles, tutorials, and other resources related to tool documentation and usability.
Browse courses on
Information Management
Show steps
Show steps
Show steps
- Identify reputable sources of information
- Search for relevant content on topics such as documentation best practices and user experience
- Organize and categorize the collected resources
Join a study group to discuss documentation and usability
Show steps
Connect with other students in the course to discuss topics related to tool usability and documentation, exchange ideas, and provide feedback.
Browse courses on
Peer Support
Show steps
Show steps
Show steps
- Find a study group or create your own
- Establish regular meeting times and agendas
- Discuss topics related to course content and explore different perspectives
Four other activities
Expand to see all activities and additional details
Show all seven activities
Explore examples of well-documented tools
Show steps
Review examples of well-documented tools to gain inspiration and ideas for your own documentation.
Browse courses on
User Experience
Show steps
Show steps
Show steps
- Identify tools in your field with a reputation for usability
- Examine their documentation for features such as clarity, organization, and accessibility
Create an infographic about tool usability
Show steps
Create an infographic that summarizes the key principles of tool usability to reinforce your understanding of the first section of the course.
Browse courses on
Informatics
Show steps
Show steps
Show steps
- Research the principles of tool usability
- Create a draft of the infographic using a template or design software
- Revise and refine the infographic based on feedback from peers or instructors
Build mock documentation for a tool
Show steps
Develop a mock documentation page for a hypothetical tool based on the concepts you learned in the section on documentation.
Browse courses on
Informatics
Show steps
Show steps
Show steps
- Identify the target audience for the tool
- Determine the purpose and scope of the documentation
- Write clear and concise content using appropriate formatting
- Test the documentation to ensure it meets the needs of users
Develop a documentation plan for an existing tool
Show steps
Select an existing tool that lacks adequate documentation and create a plan to develop comprehensive and user-friendly documentation.
Browse courses on
Project Management
Show steps
Show steps
Show steps
- Identify the tool and its target audience
- Analyze the existing documentation and identify areas for improvement
- Develop a plan for creating new or revising existing documentation
- Implement the documentation plan and test its effectiveness
Career center
Learners who complete Documentation and Usability for Cancer Informatics will develop knowledge and skills
that may be useful to these careers:
Bioinformatics Scientist
Bioinformatics Scientist
A Bioinformatics Scientist typically has a strong background in biology, computer science, and mathematics. They are responsible for developing and applying computational tools and techniques to analyze biological data. This course can help you develop the skills and knowledge you need to be successful in this role by providing you with a solid foundation in cancer informatics, including topics such as data management, analysis, and visualization.
Cancer Data Scientist
Cancer Data Scientist
A Cancer Data Scientist is responsible for collecting, analyzing, and interpreting data to identify patterns and trends in cancer research. They use their findings to develop new treatments and improve the delivery of care. This course can help you develop the skills and knowledge you need to be successful in this role by providing you with a solid foundation in cancer informatics, including topics such as data management, analysis, and visualization.
User Experience Designer
User Experience Designer
A User Experience Designer is responsible for designing and evaluating the user experience of products and services. They work with users to understand their needs and then design products and services that meet those needs. This course can help you develop the skills and knowledge you need to be successful in this role by providing you with a foundation in usability and documentation, which are essential for designing effective user experiences.
Health Informatics Specialist
Health Informatics Specialist
A Health Informatics Specialist is responsible for using technology to improve the delivery of healthcare. They work with healthcare professionals to develop and implement new systems and processes that can improve patient care. This course can help you develop the skills and knowledge you need to be successful in this role by providing you with a solid foundation in cancer informatics, which is a rapidly growing field in healthcare.
Product Manager
Product Manager
A Product Manager is responsible for planning and developing new products. They work with engineers, designers, and marketers to bring new products to market. This course can help you develop the skills and knowledge you need to be successful in this role by providing you with a foundation in usability and documentation, which are essential for developing successful products.
Technical Writer
Technical Writer
A Technical Writer is responsible for writing and editing technical documentation, such as user manuals, training materials, and white papers. This course can help you develop the skills and knowledge you need to be successful in this role by providing you with a foundation in usability and documentation, which are essential for writing effective technical documentation.
Software Developer
Software Developer
A Software Developer is responsible for designing, developing, and maintaining software applications. This course can help you develop the skills and knowledge you need to be successful in this role by providing you with a foundation in usability and documentation, which are essential for developing successful software applications.
Information Architect
Information Architect
An Information Architect is responsible for designing and organizing information systems. They work with users to understand their needs and then design systems that meet those needs. This course can help you develop the skills and knowledge you need to be successful in this role by providing you with a foundation in usability and documentation, which are essential for designing effective information systems.
Data Analyst
Data Analyst
A Data Analyst is responsible for collecting, analyzing, and interpreting data to identify patterns and trends. They use their findings to help businesses make better decisions. This course can help you develop the skills and knowledge you need to be successful in this role by providing you with a solid foundation in data analysis and visualization.
Web Developer
Web Developer
A Web Developer is responsible for designing and developing websites. This course can help you develop the skills and knowledge you need to be successful in this role by providing you with a foundation in usability and documentation, which are essential for developing effective websites.
Quality Assurance Analyst
Quality Assurance Analyst
A Quality Assurance Analyst is responsible for testing and ensuring the quality of software products. They work with developers to identify and fix bugs. This course may be useful for you if you are interested in a career in quality assurance, as it will provide you with a foundation in usability and documentation, which are essential for ensuring the quality of software products.
Medical Writer
Medical Writer
A Medical Writer is responsible for writing and editing medical documents, such as journal articles, grant proposals, and patient education materials. This course may be useful for you if you are interested in a career in medical writing, as it will provide you with a foundation in cancer informatics, which is a rapidly growing field in healthcare.
Project Manager
Project Manager
A Project Manager is responsible for planning and executing projects. They work with teams of people to achieve project goals. This course may be useful for you if you are interested in a career in project management, as it will provide you with a foundation in usability and documentation, which are essential for managing successful projects.
Clinical Research Associate
Clinical Research Associate
A Clinical Research Associate is responsible for managing and conducting clinical trials. They work with patients, physicians, and other healthcare professionals to ensure that clinical trials are conducted safely and efficiently. This course may be useful for you if you are interested in a career in clinical research, as it will provide you with a foundation in cancer informatics, which is increasingly being used in clinical trials.
Database Administrator
Database Administrator
A Database Administrator is responsible for managing and maintaining databases. They ensure that databases are running smoothly and that data is secure. This course may be useful for you if you are interested in a career in database administration, as it will provide you with a foundation in data management, which is essential for this role.
For more career information including salaries, visit:
OpenCourser.com/course/9xduap/documentation
Reading list
We've selected 12 books
that we think will supplement your
learning. Use these to
develop background knowledge, enrich your coursework, and gain a
deeper understanding of the topics covered in
Documentation and Usability for Cancer Informatics.
Save
Classic in the field of usability engineering and provides a comprehensive overview of the principles and practices of designing usable systems. It valuable resource for anyone interested in learning more about usability and how to apply it to the design of cancer informatics tools.
Provides a comprehensive overview of the principles and practices of software architecture documentation. It valuable resource for anyone interested in learning more about how to document cancer informatics tools in a way that is clear, concise, and useful.
Provides a practical guide to the principles and practices of user experience design. It valuable resource for anyone interested in learning more about how to design cancer informatics tools that are user-friendly and easy to use.
Provides a practical guide to the principles and practices of software testing. It valuable resource for anyone interested in learning more about how to test cancer informatics tools.
Practical guide to the art and science of software development. It contains valuable advice for anyone interested in writing better code and developing more effective cancer informatics tools.
Classic in the field of software engineering and provides a timeless perspective on the challenges of developing complex software systems. It valuable read for anyone interested in understanding the challenges of developing cancer informatics tools.
Save
Provides a practical guide to writing clean code. It valuable resource for anyone interested in learning more about how to write code that is easy to read, understand, and maintain.
Save
Classic in the field of object-oriented design and provides a comprehensive overview of the principles and practices of design patterns. It valuable resource for anyone interested in learning more about how to design cancer informatics tools that are flexible and reusable.
Save
Provides a practical guide to the principles and practices of software craftsmanship. It valuable resource for anyone interested in learning more about how to write better code and develop more effective cancer informatics tools.
Provides a personal perspective on the art and science of software development. It valuable read for anyone interested in understanding the challenges and rewards of developing cancer informatics tools.
Provides a practical guide to writing readable code. It valuable resource for anyone interested in learning more about how to write code that is easy to read, understand, and maintain.
Save
Provides a comprehensive overview of the principles and practices of agile software development. It valuable resource for anyone interested in learning more about how to develop cancer informatics tools using agile methods.
For more information about how these books relate to this course, visit:
OpenCourser.com/course/9xduap/documentation
Share
Similar courses
Here are nine courses similar to
Documentation and Usability for Cancer Informatics.
Computing for Cancer Informatics
OpenCourser.com/course/t6koj6/computing
Computing for Cancer Informatics
Most relevant
Leadership for Cancer Informatics Research
OpenCourser.com/course/i2t5n5/leadership
Leadership for Cancer Informatics Research
Most relevant
Advanced Reproducibility in Cancer Informatics
OpenCourser.com/course/3dbxcw/advanced
Advanced Reproducibility in Cancer Informatics
Most relevant
GenAI for UX Designers
OpenCourser.com/course/c2mc1u/genai
GenAI for UX Designers
Introduction to Reproducibility in Cancer Informatics
OpenCourser.com/course/3eieyn/introduction
Introduction to Reproducibility in Cancer Informatics
Effective Content and Information Management in Your Team - Help Your Team to Reduce Search Time
OpenCourser.com/course/8ffo3a/effective
Effective Content and Information Management in Your Team...
Digital Skills: User Experience
OpenCourser.com/course/focsz2/digital
Digital Skills: User Experience
Health Informatics for better and safer healthcare
OpenCourser.com/course/t5qmrw/health
Health Informatics for better and safer healthcare
Evaluating User Interfaces
OpenCourser.com/course/xavup1/evaluating
Evaluating User Interfaces
Effort
3 hours a week
Level
Intermediate
Via
Coursera
Institution
Johns Hopkins University
Instructor
Candace Savonen, MS
Language
English
Good to know
Teaches how to improve documentation of bioinformatics tools for cancer research
Covers broader concepts of usability from the field of user design and what that might mean for informatics tool development
Develops higher quality documentation that will enhance usability of a tool
Emphasizes the importance of identifying your user community
Provides guidance on obtaining feedback from your users to enhance the usability of your tool
Offers hands-on exercises with templates for building documentation and tutorials for cancer informatics tools
Our mission
OpenCourser helps millions of learners each year. People visit us to learn workspace skills, ace their exams, and nurture their curiosity.
Our extensive catalog contains over 50,000 courses and twice as many books. Browse by search, by topic, or even by career interests. We'll match you to the right resources quickly.
Find this site helpful? Tell a friend about us.
Affiliate disclosure
We're supported by our community of learners. When you purchase or subscribe to courses and programs or purchase books, we may earn a commission from our partners.
Your purchases help us maintain our catalog and keep our servers humming without ads.
Thank you for supporting OpenCourser.
© 2016 - 2024 OpenCourser