@@ -40,15 +40,20 @@ Display usage information:
4040templatetool --help
4141```
4242
43- ## Run Self-Validation
43+ ## Self-Validation
4444
45- Run self-validation tests:
45+ Self-validation produces a report demonstrating that Template DotNet Tool is functioning
46+ correctly. This is useful in regulated industries where tool validation evidence is required.
47+
48+ ### Running Validation
49+
50+ To perform self-validation:
4651
4752``` bash
4853templatetool --validate
4954```
5055
51- Save validation results to a file:
56+ To save validation results to a file:
5257
5358``` bash
5459templatetool --validate --results results.trx
@@ -57,15 +62,38 @@ templatetool --validate --results results.trx
5762The results file format is determined by the file extension: ` .trx ` for TRX (MSTest) format,
5863or ` .xml ` for JUnit format.
5964
60- ## Self-Validation Tests
65+ ### Validation Report
66+
67+ The validation report contains the tool version, machine name, operating system version,
68+ .NET runtime version, timestamp, and test results.
69+
70+ Example validation report:
71+
72+ ``` text
73+ # DEMA Consulting Template DotNet Tool
74+
75+ | Information | Value |
76+ | :------------------ | :------------------------------------------------- |
77+ | Tool Version | 1.0.0 |
78+ | Machine Name | BUILD-SERVER |
79+ | OS Version | Ubuntu 22.04.3 LTS |
80+ | DotNet Runtime | .NET 10.0.0 |
81+ | Time Stamp | 2024-01-15 10:30:00 UTC |
82+
83+ ✓ Version Display Test - PASSED
84+ ✓ Help Display Test - PASSED
85+
86+ Total Tests: 2
87+ Passed: 2
88+ Failed: 0
89+ ```
90+
91+ ### Validation Tests
6192
62- The self-validation verifies the tool is functioning correctly in the deployment environment.
63- The following tests are performed:
93+ Each test proves specific functionality works correctly:
6494
65- | Test Name | Proves |
66- | ----------------------------- | ----------------------------------------------------- |
67- | ` TemplateTool_VersionDisplay ` | ` --version ` outputs a valid version string |
68- | ` TemplateTool_HelpDisplay ` | ` --help ` outputs usage and options information |
95+ - ** ` TemplateTool_VersionDisplay ` ** - ` --version ` outputs a valid version string.
96+ - ** ` TemplateTool_HelpDisplay ` ** - ` --help ` outputs usage and options information.
6997
7098## Silent Mode
7199
0 commit comments