Appendix D. Documentation Standards

As network administrators begin to write many scripts, a need for standards becomes rapidly apparent. Large companies commonly maintain a collection of enterprise scripts that have been tested and approved for use as network tools. To ensure these scripts can be readily maintained, modified, and debugged, proper documentation must be included with them. This appendix offers suggestions for what kind of information to include with these scripts.

Header Information Section

The following items should be considered for inclusion in the Header information section of a script:

  • Script name

  • Script writer

  • Date the script was written

  • Version information

  • Description of the purpose of the script

  • Special requirements for use of ...

Get Microsoft® VBScript Step by Step now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.