Skip to content

Software Documentation Templates

Copy-paste templates for documenting products and product versions in the Software catalog.


Files

File Use
PRODUCT-TEMPLATE.md Product overview - copy to Installation/Software/<ND-XXXXX>/README.md. One page per ND product (article number), listing all known versions with links to their version subfolders.
VERSION-TEMPLATE.md Version install doc - copy to Installation/Software/<ND-XXXXX>/<ND-XXXXXv>/README.md. One page per product VERSION; this is the install-bearing document. Handles missing PD/PI sheets by tagging each install step with its source ([PD]/[PI]/[MODE]/[WIKI]/[OBS]/[INF]).

Both templates require verified facts; anything inferred is marked UNVERIFIED / TODO. Worked example of the process: ../INSTALL-METHODOLOGY.md.


Parent: ../README.md