Technical documentation the next tech can use: system pages, commands, placeholders and runbook fixes
For service desk and MSP technicians who already write ticket notes and simple process documents, and now need to write the technical pages other technicians rely on at 2 a.m.: system pages, runbooks with commands, and corrections to documentation that has gone stale. It builds on 'Writing a clear process document' and 'Structured troubleshooting and useful documentation'. You'll state audience, scope and prerequisites; write a system page that never records secrets; write steps with commands, explained placeholders and expected output; place warnings and verification where readers need them; and correct an existing runbook. It uses Google's developer documentation style guide and Technical Writing course, the Microsoft Writing Style Guide, GOV.UK's technical style guide and NIST SP 800-34's list of what a system record holds; your documentation platform (for example IT Glue or Hudu) and your organisation's templates decide where and how pages are kept. Ends with a supervisor-graded system page and runbook that another technician follows.
- Level
- Beginner
- Length
- About 90 minutes
- Contents
- 5 lessons · final exam
- Status
- Published · updated 10 Oct 2026
Skills you'll practise
- Write the audience, scope and prerequisites for a technical document so the next technician knows whether it applies to them
- Write a system page that records what a system is, where it runs, how to reach it, what it depends on and who owns it, without recording secrets
- Write procedure steps with commands, explained placeholders and expected output that another technician can copy and verify
- Place warnings, conditions and verification steps where the reader needs them, using must, should and can consistently
- Correct an existing runbook by finding stale, ambiguous or unsafe content, and record what changed and when it was last verified
Course outline
- 1.Write the audience, scope and prerequisitesLesson · 14 min
- 2.Write a system page that never records secretsLesson · 14 min
- 3.Write procedure steps with commands, explained placeholders and expected outputLesson · 18 min
- 4.Place warnings, conditions and verification where the reader needs themLesson · 14 min
- 5.Correct an existing runbook and record what changedLesson · 14 min
- 6.Technical documentation the next tech can use: system pages, commands, placeholders and runbook fixes: knowledge checkKnowledge check · 14 questions
- 7.Technical documentation the next tech can use: system pages, commands, placeholders and runbook fixes: practical exerciseKnowledge check · 1 question
- 8.Final exam10 questions · passing it completes the course, so people who already know the material can test out
Sources it draws on
The lessons and questions are written from these references, so learners can go back to the original.
- Google developer documentation style guide: Procedures
- Google developer documentation style guide: Format placeholders
- Google developer documentation style guide: Document command-line syntax
- Google developer documentation style guide: Code samples
- Google developer documentation style guide: Notes, cautions, warnings, and other notices
- Google Technical Writing One: Audience
- Google Technical Writing One: Documents
- Microsoft Writing Style Guide: Writing step-by-step instructions
- Microsoft Writing Style Guide: Code examples
- GOV.UK content and publishing guidance: Technical A to Z style guide
- NIST SP 800-34 Rev. 1: Contingency Planning Guide for Federal Information Systems (plan appendices)
See it with your own jobs and topics
Tell us about your team and we'll walk you through setup, from choosing jobs to your first skills check.