Documentation and Usability for Cancer Informatics from Coursera

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.

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

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

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

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

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

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.

See salaries and explore the career path for Bioinformatics 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.

See salaries and explore the career path for Cancer Data Scientist

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.

See salaries and explore the career path for User Experience Designer

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.

See salaries and explore the career path for Health Informatics Specialist

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.

See salaries and explore the career path for Product Manager

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.

See salaries and explore the career path for Technical Writer

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.

See salaries and explore the career path for Software Developer

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.

See salaries and explore the career path for Information Architect

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.

See salaries and explore the career path for Data Analyst

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.

See salaries and explore the career path for Web Developer

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.

See salaries and explore the career path for Quality Assurance Analyst

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.

See salaries and explore the career path for Medical Writer

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.

See salaries and explore the career path for Project Manager

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.

See salaries and explore the career path for Clinical Research Associate

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.

See salaries and explore the career path for Database Administrator