Skip to content

Commit b987279

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 20a538a commit b987279

22 files changed

Lines changed: 1636 additions & 1 deletion

File tree

‎docs/dev/reports/tool_inventory.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Tool Inventory for UAT Standardization
2+
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
21+
22+
## Additional validation coverage
23+
- tools/index.html
24+
- tools/renderToolsIndex.js
25+
- tools/toolRegistry.js
26+
27+
## Path standard
28+
- `docs/tools/<tool-name>/uat.md`
29+
30+
## Removed/forbidden path
31+
- `docs/tools/testing/`

‎docs/dev/reports/tool_uat_template.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Tool UAT Template
2+
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/`

‎docs/pr/BUILD_PR_LEVEL_21_2_TOOL_UAT_STANDARDIZATION_FULL_SET_V2.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# BUILD_PR_LEVEL_21_2_TOOL_UAT_STANDARDIZATION_FULL_SET_V2
2+
3+
## Purpose
4+
Normalize the full tools documentation set to UAT, not testing.
5+
6+
## Scope
7+
- create `docs/tools/<tool-name>/uat.md` for all primary tools
8+
- add Tools Index / Registry UAT coverage
9+
- standardize UAT terminology
10+
- explicitly remove old `docs/tools/testing/` path from the standard
11+
12+
## Roadmap intent
13+
This PR may complete:
14+
- create full testing documentation for each tool
15+
- define manual test cases per tool
16+
- standardize validation reports under docs/dev/reports
17+
18+
using UAT naming and structure.
19+
20+
## Hard rules
21+
- use `uat.md`, not `testing.md`
22+
- use `docs/tools/<tool-name>/uat.md`, not `docs/tools/testing/`
23+
- preserve unrelated working-tree changes

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

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# 3D Asset Viewer — UAT (User Acceptance Validation)
2+
3+
## Purpose
4+
Validate that the 3D Asset Viewer meets user expectations for primary workflows, stability, and acceptance readiness.
5+
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.
15+
16+
## Validation Scenarios
17+
18+
### VS-001: Launch Tool
19+
**Steps**
20+
1. Open the tool.
21+
22+
**Acceptance Criteria**
23+
- UI loads correctly
24+
- No blocking console errors
25+
26+
**Outcome**
27+
- [ ] PASS
28+
- [ ] FAIL
29+
30+
### VS-002: Core Workflow
31+
**Steps**
32+
1. Perform the primary create/edit workflow for this tool.
33+
34+
**Acceptance Criteria**
35+
- Main workflow behaves correctly
36+
- State remains consistent
37+
- No unexpected reset/crash
38+
39+
**Outcome**
40+
- [ ] PASS
41+
- [ ] FAIL
42+
43+
### VS-003: Save / Export / Handoff
44+
**Steps**
45+
1. Save, export, or hand off data if applicable.
46+
47+
**Acceptance Criteria**
48+
- Output is created correctly
49+
- Reload/reuse path works if supported
50+
51+
**Outcome**
52+
- [ ] PASS
53+
- [ ] FAIL
54+
55+
## Boundary Conditions
56+
57+
### BC-001: Invalid Input
58+
- [ ] Tool does not crash
59+
- [ ] Error is handled clearly
60+
61+
### BC-002: Larger Dataset / Stress Case
62+
- [ ] Tool remains responsive
63+
- [ ] No blocking corruption or freeze
64+
65+
## Stability Validation
66+
- [ ] Existing sample content still loads if applicable
67+
- [ ] No visible UI regressions
68+
- [ ] No blocking console errors during normal use
69+
70+
## Known Limitations
71+
- Record current constraints here.
72+
73+
## Validation Artifacts
74+
- Screenshots
75+
- Exported files or saved data
76+
- Console log notes
77+
78+
## 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+
84+
## Final Status
85+
- [ ] ACCEPTED
86+
- [ ] REJECTED
87+
- [ ] BLOCKED
88+
89+
## Notes
90+
Document findings, issues, and follow-up work.

‎docs/tools/3d-camera-path-editor/uat.md‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# 3D Camera Path Editor — UAT (User Acceptance Validation)
2+
3+
## Purpose
4+
Validate that the 3D Camera Path Editor meets user expectations for primary workflows, stability, and acceptance readiness.
5+
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.
15+
16+
## Validation Scenarios
17+
18+
### VS-001: Launch Tool
19+
**Steps**
20+
1. Open the tool.
21+
22+
**Acceptance Criteria**
23+
- UI loads correctly
24+
- No blocking console errors
25+
26+
**Outcome**
27+
- [ ] PASS
28+
- [ ] FAIL
29+
30+
### VS-002: Core Workflow
31+
**Steps**
32+
1. Perform the primary create/edit workflow for this tool.
33+
34+
**Acceptance Criteria**
35+
- Main workflow behaves correctly
36+
- State remains consistent
37+
- No unexpected reset/crash
38+
39+
**Outcome**
40+
- [ ] PASS
41+
- [ ] FAIL
42+
43+
### VS-003: Save / Export / Handoff
44+
**Steps**
45+
1. Save, export, or hand off data if applicable.
46+
47+
**Acceptance Criteria**
48+
- Output is created correctly
49+
- Reload/reuse path works if supported
50+
51+
**Outcome**
52+
- [ ] PASS
53+
- [ ] FAIL
54+
55+
## Boundary Conditions
56+
57+
### BC-001: Invalid Input
58+
- [ ] Tool does not crash
59+
- [ ] Error is handled clearly
60+
61+
### BC-002: Larger Dataset / Stress Case
62+
- [ ] Tool remains responsive
63+
- [ ] No blocking corruption or freeze
64+
65+
## Stability Validation
66+
- [ ] Existing sample content still loads if applicable
67+
- [ ] No visible UI regressions
68+
- [ ] No blocking console errors during normal use
69+
70+
## Known Limitations
71+
- Record current constraints here.
72+
73+
## Validation Artifacts
74+
- Screenshots
75+
- Exported files or saved data
76+
- Console log notes
77+
78+
## 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+
84+
## Final Status
85+
- [ ] ACCEPTED
86+
- [ ] REJECTED
87+
- [ ] BLOCKED
88+
89+
## Notes
90+
Document findings, issues, and follow-up work.

‎docs/tools/3d-map-editor/uat.md‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# 3D Map Editor — UAT (User Acceptance Validation)
2+
3+
## Purpose
4+
Validate that the 3D Map Editor meets user expectations for primary workflows, stability, and acceptance readiness.
5+
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.
15+
16+
## Validation Scenarios
17+
18+
### VS-001: Launch Tool
19+
**Steps**
20+
1. Open the tool.
21+
22+
**Acceptance Criteria**
23+
- UI loads correctly
24+
- No blocking console errors
25+
26+
**Outcome**
27+
- [ ] PASS
28+
- [ ] FAIL
29+
30+
### VS-002: Core Workflow
31+
**Steps**
32+
1. Perform the primary create/edit workflow for this tool.
33+
34+
**Acceptance Criteria**
35+
- Main workflow behaves correctly
36+
- State remains consistent
37+
- No unexpected reset/crash
38+
39+
**Outcome**
40+
- [ ] PASS
41+
- [ ] FAIL
42+
43+
### VS-003: Save / Export / Handoff
44+
**Steps**
45+
1. Save, export, or hand off data if applicable.
46+
47+
**Acceptance Criteria**
48+
- Output is created correctly
49+
- Reload/reuse path works if supported
50+
51+
**Outcome**
52+
- [ ] PASS
53+
- [ ] FAIL
54+
55+
## Boundary Conditions
56+
57+
### BC-001: Invalid Input
58+
- [ ] Tool does not crash
59+
- [ ] Error is handled clearly
60+
61+
### BC-002: Larger Dataset / Stress Case
62+
- [ ] Tool remains responsive
63+
- [ ] No blocking corruption or freeze
64+
65+
## Stability Validation
66+
- [ ] Existing sample content still loads if applicable
67+
- [ ] No visible UI regressions
68+
- [ ] No blocking console errors during normal use
69+
70+
## Known Limitations
71+
- Record current constraints here.
72+
73+
## Validation Artifacts
74+
- Screenshots
75+
- Exported files or saved data
76+
- Console log notes
77+
78+
## 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+
84+
## Final Status
85+
- [ ] ACCEPTED
86+
- [ ] REJECTED
87+
- [ ] BLOCKED
88+
89+
## Notes
90+
Document findings, issues, and follow-up work.

0 commit comments

Comments
 (0)