Add explanatory comments to workflow jobs

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>

Author: Copilot

.github/workflows/build.yaml

@@ -10,6 +10,8 @@ on:
         required: true
 
 jobs:
+  # Performs quick quality checks for project formatting consistency including
+  # markdown linting, spell checking, and YAML validation.
   quality-checks:
     name: Quality Checks
     runs-on: ubuntu-latest
@@ -35,6 +37,9 @@ jobs:
         with:
           config_file: .yamllint.yaml
 
+  # Builds and unit-tests the project on supported operating systems to ensure
+  # unit-tests operate on all platforms and to run SonarScanner for generating
+  # the code quality report.
   build:
     name: Build ${{ matrix.os }}
     needs: quality-checks
@@ -130,6 +135,8 @@ jobs:
             src/DemaConsulting.TemplateDotNetTool/bin/Release/*.nupkg
             src/DemaConsulting.TemplateDotNetTool/bin/Release/*.snupkg
 
+  # Runs CodeQL security and quality analysis, gathering results to include
+  # in the code quality report.
   codeql:
     name: CodeQL Analysis
     runs-on: ubuntu-latest
@@ -188,6 +195,9 @@ jobs:
           name: codeql-sarif
           path: sarif-results/csharp.sarif
 
+  # Performs integration testing on a matrix of operating systems and .NET runtimes,
+  # involving basic tool execution and running self-validation to ensure compatibility
+  # across different platforms and runtime versions.
   integration-test:
     name: Integration Test ${{ matrix.os }} .NET ${{ matrix.dotnet-version }}
     runs-on: ${{ matrix.os }}
@@ -250,6 +260,8 @@ jobs:
           name: validation-test-results-${{ matrix.os }}-dotnet${{ matrix.dotnet-version }}
           path: validation-${{ matrix.os }}-dotnet${{ matrix.dotnet-version }}.trx
 
+  # Builds the supporting documentation including user guides, requirements,
+  # trace matrices, code quality reports, and build notes.
   build-docs:
     name: Build Documents
     runs-on: windows-latest

.github/workflows/release.yaml

@@ -18,6 +18,8 @@ on:
           - publish
 
 jobs:
+  # Calls the reusable build workflow to build, test, and generate documentation
+  # for the release version.
   build:
     name: Build
     permissions:
@@ -31,6 +33,8 @@ jobs:
     secrets:
       SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 
+  # Cuts and publishes the release, creating a GitHub release with artifacts
+  # and optionally publishing the NuGet package.
   release:
     name: Release
     runs-on: ubuntu-latest