WS17 Documentation Integrity Verification Report
Date: 2026-03-09 (re-verification pass)
Scope: All markdown files in C:\xam7\Code\help\ across 7 guides (excluding bin/, obj/, images/ directories)
Summary
| Check | Tested | Pass | Issues | Status |
|---|---|---|---|---|
| Frontmatter present | 339 | 339 | 0 | PASS |
| Frontmatter complete (5 fields) | 339 | 288 | 51 missing section |
NOTE |
| Image references | 538 | 538 | 0 broken | PASS |
| Cross-references (.md links) | 2,183 | 2,183 | 0 broken | PASS |
| Minimum 40 body lines | 339 | 326 | 13 short | NOTE |
| Related Articles section | 339 | 338 | 1 missing | NOTE |
| Images on disk vs referenced | 485 | 485 | 0 orphaned | PASS |
Overall: HEALTHY. No broken links, no broken images, no orphaned images. All issues are low-priority structural notes.
Guides Covered (7)
| Guide | Files |
|---|---|
| barcoding-guide | 19 |
| configuration-guide | 145 |
| fam-guide | 39 |
| itam-guide | 93 |
| keywedge-guide | 8 |
| maintenance-guide | 22 |
| procurement-guide | 13 |
1. Frontmatter Verification
Required fields: title, guide, chapter, section, sort
All 339 files have frontmatter. All have title, guide, chapter, and sort. 51 files are missing the section field. All 51 are how-to pages or getting-started pages -- this is a systematic pattern, not random omissions.
Breakdown
| Category | Count |
|---|---|
| barcoding-guide/how-to/ | 4 |
| configuration-guide/getting-started/ | 3 |
| configuration-guide/how-to/ | 14 |
| fam-guide/how-to/ | 12 |
| itam-guide/how-to/ | 15 |
| maintenance-guide/how-to/ | 3 |
Assessment: The how-to pages were added as a new page type. They use chapter: "How To" (or similar) and omit the section field by design. This could be normalized by adding section matching the title, but is not a defect.
2. Image References
538 image references checked. 0 broken. 485 images on disk, 0 orphaned.
All  references in all 339 markdown files resolve to existing image files.
3. Cross-References
2,183 markdown cross-references checked. 0 broken.
All [text](path.md) links between documentation pages resolve correctly. This includes links across guides (e.g., IT guide linking to Configuration guide pages).
Note: A prior verification pass (WS17.1) found and fixed 41 broken links caused by file renames and consolidation. Those fixes remain stable.
4. Short Pages (< 40 body lines)
13 pages have fewer than 40 lines of body content:
| Lines | File | Notes |
|---|---|---|
| 21 | configuration-guide/what-can-be-configured/overview.md | Index page |
| 22 | configuration-guide/what-can-be-configured/forms.md | Index page |
| 22 | configuration-guide/what-can-be-configured/task-and-incident-entry.md | Index page |
| 23 | configuration-guide/what-can-be-configured/search.md | Index page |
| 27 | configuration-guide/what-can-be-configured/overview.md | Index page |
| 30 | configuration-guide/what-can-be-configured/all-main-screens.md | Index page |
| 32 | configuration-guide/introduction/upgradeability.md | Concise topic |
| 32 | configuration-guide/custom-spec-fields/queries.md | Concise topic |
| 32 | configuration-guide/what-can-be-configured/reference-data-lookup-screens.md | Index page |
| 35 | itam-guide/asset-management/un-dispose.md | Concise topic |
| 38 | configuration-guide/what-can-be-configured/asset-entry.md | Index page |
| 39 | configuration-guide/transformations/federation-to-another-application.md | Concise topic |
| 39 | keywedge-guide/about-keywedge-scanners/overview.md | Concise topic |
Assessment: 8 of 13 are "What Can Be Configured" index/overview pages that are intentionally brief with screenshots. The remaining 5 are concise single-topic pages. No padding needed.
5. Related Articles Section
338 of 339 pages have a ## Related Articles section (or variant).
Missing from:
configuration-guide/getting-started/glossary.md-- A glossary page where Related Articles may not be applicable.
Change History
| Pass | Date | Found | Fixed |
|---|---|---|---|
| WS17.1 | 2026-03-09 | 41 broken links, 10 duplicate sorts, 82 empty section fields | 41 links fixed, 10 sorts fixed |
| WS17.2 (this pass) | 2026-03-09 | 0 broken links, 0 broken images, 51 missing section fields, 13 short pages, 1 missing Related Articles | 0 fixes needed |
Recommendations
- Low priority: Add
sectionfield to 51 how-to/getting-started pages for frontmatter consistency. - Optional: Consider expanding the 5 non-index short pages if more detail would help users.
- Optional: Add Related Articles to the glossary page if appropriate links exist.