Percent sign % represents the regular command shell prompt.
Square brackets surround optional items.Īngle brackets surround user-supplied values.
Monospace – Screen output and code samples appear in monospace type. This includes user-supplied information on command lines. Italic – Variable information appears in italic type. The names of directories, files, machines, partitions, and volumes also appear in bold. You can also select a style and you can get Word to show you where in the document the style is applied. To make this document more useful, we’ve added the following typographical conventions to highlight key information:īold – Command and option names appear in bold type in definitions and examples. The layout of this template means that you can adjust it very quickly and use it for your own requirements. Of course, as this template is very easy to modify, you can use it for other areas, such as when troubleshooting cars, automobiles, electrical appliances, home systems, and networks. This document is designed to help end users, developers, and System Administrators who are building, deploying, and using your application. More screenshots of the template included in this pack.ġ.1.2 Prerequisites for End Users and IT Professionalsģ Appendix A: Acronyms, Abbreviations & Definitionsĥ Obtaining More Documentation Who Should Use This Troubleshooting Guide? Troubleshooting Guide Template: Red Theme These are screenshots of some of the templates included in this template pack. Troubleshooting Guide Template: Blue Theme