Skip to content

Commit 0f8f956

Browse files
author
DavidQ
committed
Standardize tool documentation to UAT structure
- created UAT docs for all primary tools - added Tools Index / Registry UAT coverage - standardized terminology from testing to UAT - corrected path standard to docs/tools/<tool-name>/uat.md - removed docs/tools/testing/ from the documentation standard
1 parent b987279 commit 0f8f956

44 files changed

Lines changed: 1009 additions & 1822 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

-tree-asteroids.txt

-1002 Bytes
Binary file not shown.

-tree-tmp.txt

-241 KB
Binary file not shown.

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This is the root onboarding entry for active project documentation.
1616
- `docs/operations/dev/POWERSHELL_SCRIPT_STRUCTURE.md`
1717
- `docs/operations/dev/CODEX_WEBSITE_REPO_DEPLOYMENT_SCRIPTING.md`
1818
- `docs/tools/README.md`
19-
- `docs/tools/testing/README.md`
19+
- `docs/dev/reports/tool_uat_template.md`
2020
5. PR and capability review surfaces:
2121
- `docs/pr/capabilities/README.md`
2222
6. Active reports:

docs/dev/reports/BUILD_PR_LEVEL_21_2_TOOL_TESTING_DOCUMENTATION_AND_REPORT_STANDARDIZATION_TOOL_INVENTORY.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@
55

66
| # | Tool | Tool Id | Entry Point | Testing Doc |
77
| --- | --- | --- | --- | --- |
8-
| 1 | Vector Map Editor | `vector-map-editor` | `tools/Vector Map Editor/index.html` | `docs/tools/testing/vector-map-editor.md` |
9-
| 2 | Vector Asset Studio | `vector-asset-studio` | `tools/Vector Asset Studio/index.html` | `docs/tools/testing/vector-asset-studio.md` |
10-
| 3 | Tilemap Studio | `tile-map-editor` | `tools/Tilemap Studio/index.html` | `docs/tools/testing/tile-map-editor.md` |
11-
| 4 | Parallax Scene Studio | `parallax-editor` | `tools/Parallax Scene Studio/index.html` | `docs/tools/testing/parallax-editor.md` |
12-
| 5 | Sprite Editor | `sprite-editor` | `tools/Sprite Editor/index.html` | `docs/tools/testing/sprite-editor.md` |
13-
| 6 | Asset Browser / Import Hub | `asset-browser` | `tools/Asset Browser/index.html` | `docs/tools/testing/asset-browser.md` |
14-
| 7 | Palette Browser / Manager | `palette-browser` | `tools/Palette Browser/index.html` | `docs/tools/testing/palette-browser.md` |
15-
| 8 | State Inspector | `state-inspector` | `tools/State Inspector/index.html` | `docs/tools/testing/state-inspector.md` |
16-
| 9 | Replay Visualizer | `replay-visualizer` | `tools/Replay Visualizer/index.html` | `docs/tools/testing/replay-visualizer.md` |
17-
| 10 | Performance Profiler | `performance-profiler` | `tools/Performance Profiler/index.html` | `docs/tools/testing/performance-profiler.md` |
18-
| 11 | Physics Sandbox | `physics-sandbox` | `tools/Physics Sandbox/index.html` | `docs/tools/testing/physics-sandbox.md` |
19-
| 12 | Asset Pipeline Tool | `asset-pipeline-tool` | `tools/Asset Pipeline Tool/index.html` | `docs/tools/testing/asset-pipeline-tool.md` |
20-
| 13 | Tile Model Converter | `tile-model-converter` | `tools/Tile Model Converter/index.html` | `docs/tools/testing/tile-model-converter.md` |
21-
| 14 | 3D Map Editor | `3d-map-editor` | `tools/3D Map Editor/index.html` | `docs/tools/testing/3d-map-editor.md` |
22-
| 15 | 3D Asset Viewer | `3d-asset-viewer` | `tools/3D Asset Viewer/index.html` | `docs/tools/testing/3d-asset-viewer.md` |
23-
| 16 | 3D Camera Path Editor | `3d-camera-path-editor` | `tools/3D Camera Path Editor/index.html` | `docs/tools/testing/3d-camera-path-editor.md` |
8+
| 1 | Vector Map Editor | `vector-map-editor` | `tools/Vector Map Editor/index.html` | `docs/tools/vector-map-editor/uat.md` |
9+
| 2 | Vector Asset Studio | `vector-asset-studio` | `tools/Vector Asset Studio/index.html` | `docs/tools/vector-asset-studio/uat.md` |
10+
| 3 | Tilemap Studio | `tile-map-editor` | `tools/Tilemap Studio/index.html` | `docs/tools/tilemap-studio/uat.md` |
11+
| 4 | Parallax Scene Studio | `parallax-editor` | `tools/Parallax Scene Studio/index.html` | `docs/tools/parallax-scene-studio/uat.md` |
12+
| 5 | Sprite Editor | `sprite-editor` | `tools/Sprite Editor/index.html` | `docs/tools/sprite-editor/uat.md` |
13+
| 6 | Asset Browser / Import Hub | `asset-browser` | `tools/Asset Browser/index.html` | `docs/tools/asset-browser/uat.md` |
14+
| 7 | Palette Browser / Manager | `palette-browser` | `tools/Palette Browser/index.html` | `docs/tools/palette-browser/uat.md` |
15+
| 8 | State Inspector | `state-inspector` | `tools/State Inspector/index.html` | `docs/tools/state-inspector/uat.md` |
16+
| 9 | Replay Visualizer | `replay-visualizer` | `tools/Replay Visualizer/index.html` | `docs/tools/replay-visualizer/uat.md` |
17+
| 10 | Performance Profiler | `performance-profiler` | `tools/Performance Profiler/index.html` | `docs/tools/performance-profiler/uat.md` |
18+
| 11 | Physics Sandbox | `physics-sandbox` | `tools/Physics Sandbox/index.html` | `docs/tools/physics-sandbox/uat.md` |
19+
| 12 | Asset Pipeline Tool | `asset-pipeline-tool` | `tools/Asset Pipeline Tool/index.html` | `docs/tools/asset-pipeline-tool/uat.md` |
20+
| 13 | Tile Model Converter | `tile-model-converter` | `tools/Tile Model Converter/index.html` | `docs/tools/tile-model-converter/uat.md` |
21+
| 14 | 3D Map Editor | `3d-map-editor` | `tools/3D Map Editor/index.html` | `docs/tools/3d-map-editor/uat.md` |
22+
| 15 | 3D Asset Viewer | `3d-asset-viewer` | `tools/3D Asset Viewer/index.html` | `docs/tools/3d-asset-viewer/uat.md` |
23+
| 16 | 3D Camera Path Editor | `3d-camera-path-editor` | `tools/3D Camera Path Editor/index.html` | `docs/tools/3d-camera-path-editor/uat.md` |

docs/dev/reports/BUILD_PR_LEVEL_21_2_TOOL_TESTING_DOCUMENTATION_AND_REPORT_STANDARDIZATION_VALIDATION.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Commands Run
44
1. `node --input-type=module -` (reads `getActiveToolRegistry()` from `tools/toolRegistry.js` and validates per-tool docs + required sections)
5-
2. `Get-ChildItem docs/tools/testing -Filter *.md | Where-Object { $_.Name -ne 'README.md' } | Select-String -Pattern '^## Manual Test Cases' | Measure-Object`
5+
2. `Get-ChildItem docs/tools -Filter *.md | Where-Object { $_.Name -ne 'README.md' } | Select-String -Pattern '^## Manual Test Cases' | Measure-Object`
66
3. `git status --short -- docs/dev/start_of_day`
77

88
## Scope Validation Results
@@ -11,7 +11,7 @@
1111
- Required sections present per tool doc: **PASS** (`missingSectionCount=0`).
1212
- Manual test-case section coverage: **PASS** (`16` docs include `## Manual Test Cases`).
1313
- Standardized template exists: **PASS** (`docs/dev/reports/tool_validation_report_template.md`).
14-
- Tool testing index exists: **PASS** (`docs/tools/testing/README.md`).
14+
- Tool testing index exists: **PASS** (`docs/tools/README.md`).
1515

1616
## Guardrail Validation
1717
- No `start_of_day` modifications: **PASS**.
@@ -22,7 +22,7 @@
2222
- `docs/README.md`
2323
- `docs/reference/root/README.md`
2424
- `docs/tools/README.md`
25-
- `docs/tools/testing/README.md`
25+
- `docs/tools/README.md`
2626

2727
## Roadmap Status Updates (Execution-Backed)
2828
Updated in `docs/dev/roadmaps/MASTER_ROADMAP_TOOLS.md`:

docs/dev/reports/tool_inventory.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
1-
# Tool Inventory for UAT Standardization
1+
# Tool Inventory
22

3-
## Primary tools with full UAT docs
4-
- 3D Asset Viewer
5-
- 3D Camera Path Editor
6-
- 3D Map Editor
7-
- Asset Browser
8-
- Asset Pipeline Tool
9-
- Palette Browser
10-
- Parallax Scene Studio
11-
- Performance Profiler
12-
- Physics Sandbox
13-
- Replay Visualizer
14-
- Sprite Editor
15-
- State Inspector
16-
- Tile Model Converter
17-
- Tilemap Studio
18-
- Tool Host
19-
- Vector Asset Studio
20-
- Vector Map Editor
3+
- Source of truth: `tools/toolRegistry.js` active registry entries + Tool Host shell coverage.
4+
- Primary tool count: 17
215

22-
## Additional validation coverage
23-
- tools/index.html
24-
- tools/renderToolsIndex.js
25-
- tools/toolRegistry.js
6+
| # | Tool | Tool ID | Entry Point | UAT Doc |
7+
| --- | --- | --- | --- | --- |
8+
| 1 | Vector Map Editor | `vector-map-editor` | `tools/Vector Map Editor/index.html` | `docs/tools/vector-map-editor/uat.md` |
9+
| 2 | Vector Asset Studio | `vector-asset-studio` | `tools/Vector Asset Studio/index.html` | `docs/tools/vector-asset-studio/uat.md` |
10+
| 3 | Tilemap Studio | `tile-map-editor` | `tools/Tilemap Studio/index.html` | `docs/tools/tilemap-studio/uat.md` |
11+
| 4 | Parallax Scene Studio | `parallax-editor` | `tools/Parallax Scene Studio/index.html` | `docs/tools/parallax-scene-studio/uat.md` |
12+
| 5 | Sprite Editor | `sprite-editor` | `tools/Sprite Editor/index.html` | `docs/tools/sprite-editor/uat.md` |
13+
| 6 | Asset Browser / Import Hub | `asset-browser` | `tools/Asset Browser/index.html` | `docs/tools/asset-browser/uat.md` |
14+
| 7 | Palette Browser / Manager | `palette-browser` | `tools/Palette Browser/index.html` | `docs/tools/palette-browser/uat.md` |
15+
| 8 | State Inspector | `state-inspector` | `tools/State Inspector/index.html` | `docs/tools/state-inspector/uat.md` |
16+
| 9 | Replay Visualizer | `replay-visualizer` | `tools/Replay Visualizer/index.html` | `docs/tools/replay-visualizer/uat.md` |
17+
| 10 | Performance Profiler | `performance-profiler` | `tools/Performance Profiler/index.html` | `docs/tools/performance-profiler/uat.md` |
18+
| 11 | Physics Sandbox | `physics-sandbox` | `tools/Physics Sandbox/index.html` | `docs/tools/physics-sandbox/uat.md` |
19+
| 12 | Asset Pipeline Tool | `asset-pipeline-tool` | `tools/Asset Pipeline Tool/index.html` | `docs/tools/asset-pipeline-tool/uat.md` |
20+
| 13 | Tile Model Converter | `tile-model-converter` | `tools/Tile Model Converter/index.html` | `docs/tools/tile-model-converter/uat.md` |
21+
| 14 | 3D Map Editor | `3d-map-editor` | `tools/3D Map Editor/index.html` | `docs/tools/3d-map-editor/uat.md` |
22+
| 15 | 3D Asset Viewer | `3d-asset-viewer` | `tools/3D Asset Viewer/index.html` | `docs/tools/3d-asset-viewer/uat.md` |
23+
| 16 | 3D Camera Path Editor | `3d-camera-path-editor` | `tools/3D Camera Path Editor/index.html` | `docs/tools/3d-camera-path-editor/uat.md` |
24+
| 17 | Tool Host | `tool-host` | `tools/Tool Host/index.html` | `docs/tools/tool-host/uat.md` |
2625

27-
## Path standard
28-
- `docs/tools/<tool-name>/uat.md`
26+
## Additional UAT Coverage
27+
- `tools/index.html`
28+
- `tools/renderToolsIndex.js`
29+
- `tools/toolRegistry.js`
30+
- UAT doc: `docs/tools/tools-index-registry/uat.md`
2931

30-
## Removed/forbidden path
31-
- `docs/tools/testing/`
32+
## Standard Path
33+
- `docs/tools/<tool-name>/uat.md`
Lines changed: 34 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,36 @@
11
# Tool UAT Template
22

3-
## File Path
4-
`docs/tools/<tool-name>/uat.md`
5-
6-
## Required Sections
7-
- Purpose
8-
- Environment
9-
- Setup
10-
- Validation Scenarios
11-
- Boundary Conditions
12-
- Stability Validation
13-
- Known Limitations
14-
- Validation Artifacts
15-
- Acceptance Criteria
16-
- Final Status
17-
- Notes
18-
19-
## Terminology Standard
20-
- Use `UAT`
21-
- Use `Validation Scenarios`
22-
- Use `Acceptance Criteria`
23-
- Do not use `testing.md`
24-
- Do not use `docs/tools/testing/`
3+
## Tool Metadata
4+
- Tool name:
5+
- Tool id:
6+
- Entry point:
7+
- Date:
8+
- Environment:
9+
10+
## Validation Scenarios
11+
### VS-001
12+
**Steps**
13+
1.
14+
15+
**Acceptance Criteria**
16+
-
17+
18+
**Outcome**
19+
- [ ] PASS
20+
- [ ] FAIL
21+
- [ ] BLOCKED
22+
23+
## Acceptance Criteria
24+
-
25+
26+
## Outcome
27+
- [ ] ACCEPTED
28+
- [ ] REJECTED
29+
- [ ] BLOCKED
30+
31+
## Notes
32+
-
33+
34+
## Path Standard
35+
- Use `docs/tools/<tool-name>/uat.md`.
36+
- Do not use legacy testing-path standards.

docs/reference/root/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ README.md
1919
- [Docs Home](../../README.md)
2020
- [Workflow Surface](../../operations/dev/README.md)
2121
- [Master Roadmap](../../dev/roadmaps/MASTER_ROADMAP_ENGINE.md)
22-
- [Tool Testing Docs](../../tools/testing/README.md)
22+
- [Tool UAT Docs](../../tools/README.md)
2323
- [Architecture Overview](../architecture-standards/architecture/README.md)
2424
- [Standards](../architecture-standards/standards/README.md)
2525
- [PR Capability Bundles](../../pr/capabilities/README.md)

docs/tools/3d-asset-viewer/uat.md

Lines changed: 50 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,93 @@
1-
# 3D Asset Viewer UAT (User Acceptance Validation)
1+
# 3D Asset Viewer - UAT
22

33
## Purpose
4-
Validate that the 3D Asset Viewer meets user expectations for primary workflows, stability, and acceptance readiness.
4+
Validate user acceptance readiness for 3D Asset Viewer across launch, core workflow, and handoff behavior.
55

6-
## Environment
7-
- Browser: Chrome (latest)
8-
- OS: Windows 10/11
9-
- Repo: HTML-JavaScript-Gaming (latest)
10-
11-
## Setup
12-
1. Open the tool entry point.
13-
2. Launch the tool in browser.
14-
3. Confirm the tool loads without blocking errors.
6+
## Scope
7+
- Tool: `3d-asset-viewer`
8+
- Entry point: `tools/3D Asset Viewer/index.html`
159

1610
## Validation Scenarios
1711

18-
### VS-001: Launch Tool
12+
### VS-001 Launch And Boot
1913
**Steps**
20-
1. Open the tool.
14+
1. Open the tool entry point.
15+
2. Wait for initial UI render.
2116

2217
**Acceptance Criteria**
23-
- UI loads correctly
24-
- No blocking console errors
18+
- Tool UI renders without blocking errors.
19+
- No uncaught console exceptions during initial load.
2520

2621
**Outcome**
2722
- [ ] PASS
2823
- [ ] FAIL
24+
- [ ] BLOCKED
2925

30-
### VS-002: Core Workflow
26+
### VS-002 Open Or Load Workflow
3127
**Steps**
32-
1. Perform the primary create/edit workflow for this tool.
28+
1. Load a default, sample, or existing document/state where applicable.
29+
2. Confirm data appears in the expected UI surfaces.
3330

3431
**Acceptance Criteria**
35-
- Main workflow behaves correctly
36-
- State remains consistent
37-
- No unexpected reset/crash
32+
- Loaded content matches expected structure.
33+
- Tool remains responsive after load.
3834

3935
**Outcome**
4036
- [ ] PASS
4137
- [ ] FAIL
38+
- [ ] BLOCKED
4239

43-
### VS-003: Save / Export / Handoff
40+
### VS-003 Create Or Edit Workflow
4441
**Steps**
45-
1. Save, export, or hand off data if applicable.
42+
1. Create new content or edit existing content.
43+
2. Verify state updates in the active panels/canvas.
4644

4745
**Acceptance Criteria**
48-
- Output is created correctly
49-
- Reload/reuse path works if supported
46+
- Core workflow executes without crash or silent data loss.
47+
- Visual/state feedback reflects edits consistently.
5048

5149
**Outcome**
5250
- [ ] PASS
5351
- [ ] FAIL
52+
- [ ] BLOCKED
5453

55-
## Boundary Conditions
54+
### VS-004 Save Export Or Handoff
55+
**Steps**
56+
1. Execute save/export/handoff path where applicable.
57+
2. Reopen or consume output in downstream surface if available.
5658

57-
### BC-001: Invalid Input
58-
- [ ] Tool does not crash
59-
- [ ] Error is handled clearly
59+
**Acceptance Criteria**
60+
- Output artifact or handoff payload is produced correctly.
61+
- Reopen or downstream consumption path behaves as expected.
6062

61-
### BC-002: Larger Dataset / Stress Case
62-
- [ ] Tool remains responsive
63-
- [ ] No blocking corruption or freeze
63+
**Outcome**
64+
- [ ] PASS
65+
- [ ] FAIL
66+
- [ ] BLOCKED
6467

65-
## Stability Validation
66-
- [ ] Existing sample content still loads if applicable
67-
- [ ] No visible UI regressions
68-
- [ ] No blocking console errors during normal use
68+
### VS-005 Invalid Input And Error Handling
69+
**Steps**
70+
1. Provide invalid or malformed input where possible.
71+
2. Observe error handling behavior.
6972

70-
## Known Limitations
71-
- Record current constraints here.
73+
**Acceptance Criteria**
74+
- Tool handles errors safely without crash.
75+
- Error messaging is visible and actionable.
7276

73-
## Validation Artifacts
74-
- Screenshots
75-
- Exported files or saved data
76-
- Console log notes
77+
**Outcome**
78+
- [ ] PASS
79+
- [ ] FAIL
80+
- [ ] BLOCKED
7781

7882
## Acceptance Criteria
79-
Tool is **ACCEPTED** when:
80-
- All critical scenarios pass
81-
- No blocking issues remain
82-
- No crashes occur in normal use
83+
- All critical validation scenarios are PASS.
84+
- No blocking defects remain open for launch, edit, or handoff paths.
85+
- No crash observed during normal UAT execution.
8386

84-
## Final Status
87+
## Outcome
8588
- [ ] ACCEPTED
8689
- [ ] REJECTED
8790
- [ ] BLOCKED
8891

8992
## Notes
90-
Document findings, issues, and follow-up work.
93+
- Attach screenshots, logs, and artifact paths used during UAT execution.

0 commit comments

Comments
 (0)