We may earn an affiliate commission when you visit our partners.
CodeMash

CodeMash 2020 | Let's Talk About Documentation | Mike Hand

Every field requires documentation, and some are far better at it than others. In this conference talk, Mike Hand will take a tour through the highlights and lowlights, hits and misses of documentation and then see what you can apply back to the field of software development.

Enroll now

What's inside

Syllabus

Let's Talk About Documentation

Good to know

Know what's good
, what to watch for
, and possible dealbreakers
Examines various facets of documentation in other fields
Provides insights from the software development industry
Delivered by an expert in the field of documentation, Mike Hand

Save this course

Save Let's Talk About Documentation: CodeMash to your list so you can find it easily later:
Save

Activities

Coming soon We're preparing activities for Let's Talk About Documentation: CodeMash. These are activities you can do either before, during, or after a course.

Career center

Learners who complete Let's Talk About Documentation: CodeMash will develop knowledge and skills that may be useful to these careers:
Technical Writer
Technical Writers create documentation to help users understand technical products or services. In this role, you would leverage the insights you gained from this course on documentation best practices to create clear and concise user manuals, tutorials, and other supporting materials. This course will help you develop the skills needed to effectively convey complex technical information to a non-technical audience.
Software Developer
Software Developers design, develop, and test computer software. In this role, you would use the knowledge you gained from this course on documentation best practices to write clear and concise documentation for your code and software projects. This will help ensure that your code is easy to understand and maintain, and that other developers can easily collaborate on your projects.
UX Writer
UX Writers create content for user interfaces, such as website copy, app text, and error messages. In this role, you would use the insights you gained from this course on documentation best practices to create clear and concise UX writing that helps users easily understand and use your products.
Product Manager
Product Managers plan and oversee the development of products. In this role, you would use the insights you gained from this course on documentation best practices to create clear and concise product documentation, including user manuals, marketing materials, and product roadmaps. This will help ensure that your products are well-documented and easy to use.
Information Architect
Information Architects design and organize the structure and content of websites and other digital products. In this role, you would use the knowledge you gained from this course on documentation best practices to create clear and concise documentation for your information architecture projects. This will help ensure that your websites and other digital products are easy to navigate and use.
Content Strategist
Content Strategists plan and oversee the creation and distribution of content. In this role, you would use the insights you gained from this course on documentation best practices to create clear and concise content strategies for your organization. This will help ensure that your content is effective and meets the needs of your audience.
Instructional Designer
Instructional Designers create and develop educational materials and programs. In this role, you would use the knowledge you gained from this course on documentation best practices to create clear and concise instructional materials that help learners easily understand and apply new knowledge and skills.
Technical Communicator
Technical Communicators create and deliver information about technical products and services. In this role, you would use the insights you gained from this course on documentation best practices to create clear and concise technical documentation, such as user manuals, white papers, and training materials. This will help ensure that your technical information is easy to understand and use.
Knowledge Manager
Knowledge Managers oversee the creation, organization, and dissemination of knowledge within an organization. In this role, you would use the insights you gained from this course on documentation best practices to create clear and concise knowledge management systems and processes. This will help ensure that your organization's knowledge is well-documented and easily accessible to employees.
Archivist
Archivists preserve and manage historical records and documents. In this role, you would use the knowledge you gained from this course on documentation best practices to create clear and concise archival documentation to help researchers and other users access and use the historical records in your care.
Librarian
Librarians organize and manage information resources. In this role, you would use the knowledge you gained from this course on documentation best practices to create clear and concise library catalogs and other documentation to help patrons find and use the information they need.
Historian
Historians research, analyze, and interpret the past. In this role, you would use the knowledge you gained from this course on documentation best practices to create clear and concise historical research and writing. This will help ensure that your research is well-documented and accessible to other historians and scholars.
Museum curator
Museum Curators plan and oversee the development and care of museum collections. In this role, you would use the knowledge you gained from this course on documentation best practices to create clear and concise documentation for your museum's collection, including object descriptions, exhibition labels, and educational materials.
Journalist
Journalists research, write, and report on current events and issues. In this role, you would use the knowledge you gained from this course on documentation best practices to create clear and concise news articles and other journalistic content. This will help ensure that your reporting is accurate, fair, and accessible to the public.
Lawyer
Lawyers advise and represent clients on legal matters. In this role, you would use the knowledge you gained from this course on documentation best practices to create clear and concise legal documents, such as contracts, wills, and briefs. This will help ensure that your clients' legal interests are protected.

Reading list

We haven't picked any books for this reading list yet.

Share

Help others find this course page by sharing it with your friends and followers:

Similar courses

Similar courses are unavailable at this time. Please try again later.
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