Software Documentation
Documenting software for users and developers — getting-started guides, how-tos, reference and release notes.
- Docs-as-code
- How-to guides
- Release notes
Planned: A planned subject in the curriculum roadmap. The outline below is a proposed structure, not a finished course.
Learning outcomes
By the end, learners will be able to:
- 01
Choose the right documentation type for each need
- 02
Write tutorials, how-tos, reference and explanations
- 03
Work in a docs-as-code workflow
- 04
Maintain docs alongside releases
Proposed module outline
A proposed structure — refined during curriculum development.
Tutorials, how-tos, reference, explanation.
First-success experiences.
Accuracy and completeness.
Version control and review workflows.
Communicating change clearly.
Course enquiry
Interested in Software Documentation?
Ask about availability, private training or having this curriculum developed for your organisation.
Send a message
The online form is not switched on yet. Please message me directly — your details below are already filled in.
Related training
- PlannedWritingBeginner
Technical Writing Fundamentals
Writing clear, concise, audience-focused technical content — structure, plain language, style and review.
- Plain language
- Structure
- Style guides
- PlannedWritingIntermediate
API Documentation Fundamentals
Documenting REST APIs — authentication, endpoints, parameters, examples, errors and OpenAPI specifications.
- REST
- OpenAPI
- Code samples
- PlannedWritingIntermediate
User Manual Development
Planning and producing user manuals — task analysis, procedures, screenshots, safety notes and publishing.
- Manuals
- Procedures
- Screenshots