Technical Writing & Documentation
Write installation guides, API references, user guides and requirements that readers can actually follow, and keep them accurate as the product changes.
- Planned 21 days
- About 1 h per day
- 6 planned modules
This course is in development and not yet available for purchase. The planned curriculum below is a draft and may change before launch.
Overview
A short, practical course of about three weeks at an hour a day. You learn what technical documentation is for, how to analyse readers and the tasks they need to complete, how to write step-by-step installation guides and troubleshooting pages, how API reference documentation is structured, how to write task-based user guides and testable requirements, how to organise documentation so people can find answers, how to keep documentation in version control next to the code, and how to edit and review for clarity and accuracy. The project is a complete documentation package for a sample software product.
What you will be able to do
- Analyse readers and the tasks they need to complete
- Write accurate, tested step-by-step installation and how-to guides
- Structure API reference documentation and task-based user guides
- Write testable requirements and useful troubleshooting pages
- Organise documentation so readers can find answers quickly
- Edit, review and version documentation alongside a product
Before you start
- Comfortable writing in English
- Basic computer and web skills
Planned curriculum
A draft outline of the modules being written. Lessons are not available yet, and the outline may change after expert review.
Availability
This course is not on sale yet. It becomes available only after its lessons, assessments and resources pass Yumeora's review. When published, it is planned to be included in Yumeora All-Access.