US09-04 — Write the User Manual with Generated Screenshots #105
Notifications
Due Date
No due date set.
Blocks
Depends on
#106 US09-05 — Automate Documentation Acceptance
domverse/photoanalyzer
#102 US09-01 — Serve the Documentation Inside the Application
domverse/photoanalyzer
Reference: domverse/photoanalyzer#105
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Source specification: delivery_backlog/stories/US09-04-user-manual.md
US09-04 — Write the User Manual with Generated Screenshots
Epic: E09
As the person actually sorting a photo library, I want a manual that walks the workflow
screen by screen and tells me what each refusal means, so that I can use the application
confidently and know what it is about to do to my files before it does it.
Acceptance criteria
inventory, duplicate review, safety review, analysis, album proposals, renames, upload,
archive, and diagnostics. Each page answers the same four questions: what this stage is
for, what I have to decide, what it changes on disk or on the server, and what it
refuses to do.
the point of no return in each stage and what is reversible after it.
state being described.
fixture library, drives the application, and writes the images. Regenerating them is one
documented command. No screenshot is captured by hand.
fixture library is synthetic, and this is asserted rather than assumed.
error.codethe API can return, with whatcauses it, what the application did or refused to do, and what the operator should do
next. Refusals that protect data (
lock_held,rename_recovery_required,stale_preflight,path_not_allowed,host_not_allowed,dry_run_not_approved,conflict codes) are explained as intentional, not as faults.
restored backup — what the application does by itself and what needs a decision.
docs/images/**, since therepository denies image files by default. This is an explicit, reviewed change, not a
quiet one, and it stays narrow enough that a real photo still cannot be committed.
Automated tests
error.codethe application can emit is documented, and every code documentedexists in the code — both directions.
docs/images/is referenced by a page.image the manual references, against a temporary fixture library that is destroyed
afterwards.
the configured secrets.
and no console error.
Dependencies
Claimed for implementation on branch
us/US09-04-write-the-user-manual-with-generated-screenshots.Submitted for review: #110
Tests passed:
work_item/scripts/python -m unittest discover -s work_item/tests -vwork_item/scripts/python -m pytest tests -qwork_item/scripts/python -m pytest tests/integration/test_user_manual.py tests/e2e/test_user_manual_screenshots.py -qCompleted and merged via PR #110.