Technical Documentation Templates (1997)
Templates for the four types of technical documentation — tutorial, how-to, reference, explanation — plus the NMS runbook that saved us during production incidents.
documentationcommunicationengineering
Technical Documentation Templates (1997)
Ready-to-use templates for each documentation type, plus the actual NMS runbook we used in production.
Contents
templates/tutorial.md— structure for a learning-oriented walkthroughtemplates/how-to.md— structure for a task-oriented guidetemplates/reference.md— structure for a lookup reference (config options, API parameters)templates/explanation.md— structure for a conceptual deep-divenms-runbook.md— the actual NMS production runbook: health checks, common failures, recovery steps