US09-04: Write the User Manual with Generated Screenshots (#110)
This commit was merged in pull request #110.
This commit is contained in:
@@ -15,18 +15,32 @@ repository under `docs/`, on Gitea, and inside the running application under
|
||||
2. [Installation and operations](installation.md) — host and container installation,
|
||||
every setting, the first-run checklist, upgrades, backup and restore, and what
|
||||
each refusal at startup means.
|
||||
3. [Architecture](architecture.md) — the context and runtime diagrams, what each
|
||||
3. [A guided first pass](first-pass.md) — one library from scan to verified upload,
|
||||
with the point of no return named in each stage.
|
||||
4. [Architecture](architecture.md) — the context and runtime diagrams, what each
|
||||
module owns, the three journals a restart reads, and where every invariant is
|
||||
enforced.
|
||||
|
||||
## Being written
|
||||
## The stages, one page each
|
||||
|
||||
The remaining manuals are accepted work, not aspiration; each is a story in
|
||||
[E09](https://git.domverse-berlin.eu/domverse/photoanalyzer/src/branch/main/delivery_backlog/E09-documentation.md)
|
||||
and will appear here as it lands.
|
||||
Every page answers the same four questions: what the stage is for, what you decide,
|
||||
what it changes on disk or on the server, and what it refuses.
|
||||
|
||||
- **User manual** — one page per workflow stage with screenshots of the real
|
||||
application, and a catalogue of every error and refusal (US09-04).
|
||||
1. [Inventory and discovery](stages/inventory.md)
|
||||
2. [Duplicate review](stages/duplicates.md)
|
||||
3. [Safety review](stages/safety.md)
|
||||
4. [Analysis](stages/analysis.md)
|
||||
5. [Album proposals](stages/albums.md)
|
||||
6. [Renames](stages/renames.md)
|
||||
7. [Upload](stages/uploads.md)
|
||||
8. [Archive](stages/archive.md)
|
||||
9. [Diagnostics and library statistics](stages/diagnostics.md)
|
||||
|
||||
## When something goes wrong
|
||||
|
||||
- [Errors and refusals](errors.md) — every error code, what caused it, what to do.
|
||||
- [Recovery](recovery.md) — what the application resolves by itself, and what needs
|
||||
you.
|
||||
|
||||
## Conventions
|
||||
|
||||
|
||||
Reference in New Issue
Block a user