# UAT Report Template

This template standardizes User Acceptance Testing reports for StemeDB releases.

## File Naming

`uat/{feature-or-phase}-{date}.md`

Examples:
- `phase6-distributed-2026-02-02.md`
- `skeptic-endpoint-2025-12-15.md`
- `go-sdk-v2-2026-01-20.md`

## Template

```markdown
# UAT Report: {Title}

**Date:** YYYY-MM-DD
**Phase/Feature:** {Phase or feature name}
**Tester:** {Who ran the UAT}
**Status:** PASS | FAIL | PARTIAL

## Summary

{1-2 sentence summary of what was tested and outcome}

## Scope

What was tested:
- {Bullet list of areas covered}

What was NOT tested:
- {Bullet list of excluded areas, if any}

## Environment

- Rust version: {version}
- OS: {platform}
- Commit: {git commit hash or branch}

## Test Results

### {Category 1}

| Test | Expected | Actual | Status |
|------|----------|--------|--------|
| {test name} | {expected behavior} | {actual behavior} | PASS/FAIL |

### {Category 2}

| Test | Expected | Actual | Status |
|------|----------|--------|--------|
| {test name} | {expected behavior} | {actual behavior} | PASS/FAIL |

## Issues Found

### {Issue 1 Title}

**Severity:** Critical | High | Medium | Low
**Status:** Fixed | Open | Won't Fix

{Description of the issue and resolution}

## Fixes Applied

- {List of fixes made during UAT}

## Artifacts

- {Links to logs, screenshots, or other evidence}

## Recommendations

- {Suggestions for future improvements or follow-up work}

## Sign-Off

- [ ] All critical tests pass
- [ ] No blocking issues remain
- [ ] Documentation updated
- [ ] Ready for release
```

## Best Practices

1. **Be specific** — Include actual command outputs and response bodies
2. **Document fixes** — If you fix something during UAT, record what changed
3. **Note environment** — Version mismatches cause false failures
4. **Link artifacts** — Reference logs, test output files, or screenshots
5. **Separate concerns** — One report per release/feature, not one giant doc
