Handbook: user handbook for readers and authors #141

Closed
opened 2026-11-06 09:59:57 +01:00 by miko · 1 comment
Owner

Part of #137
Depends on #140 (and #138).

What

Write the User handbook, illustrated with the generated screenshots.

Scope

Readers (short — reading should be self-explanatory):

  • Finding guides: category tree, search, menu
  • Reading a guide: steps, step images and annotations, step lines, callouts
  • PDF download, signing in, language and theme

Authors (in depth):

  • Creating a guide: title, category, cover, description
  • Steps: step images (4:3, up to three), step lines (bullets, icon lines, indentation), rich text (callouts, columns, attachments)
  • Annotations: drawing rectangles and circles, how they take the colour of their step line
  • Drafts, publishing, editing published guides (working copy / latest version, ADR-0008/0020)
  • Visibility (public/internal, most restrictive wins)
  • Ownership and wiki mode
  • Exporting and importing guide packages

Use the domain terms from GLOSSARY.md; English only.

Acceptance criteria

  • Every topic above has a page or section, with screenshots where text alone isn't enough
  • zensical build --strict passes
Part of #137 Depends on #140 (and #138). ## What Write the **User handbook**, illustrated with the generated screenshots. ## Scope **Readers** (short — reading should be self-explanatory): - Finding guides: category tree, search, menu - Reading a guide: steps, step images and annotations, step lines, callouts - PDF download, signing in, language and theme **Authors** (in depth): - Creating a guide: title, category, cover, description - Steps: step images (4:3, up to three), step lines (bullets, icon lines, indentation), rich text (callouts, columns, attachments) - Annotations: drawing rectangles and circles, how they take the colour of their step line - Drafts, publishing, editing published guides (working copy / latest version, ADR-0008/0020) - Visibility (`public`/`internal`, most restrictive wins) - Ownership and wiki mode - Exporting and importing guide packages Use the domain terms from `GLOSSARY.md`; English only. ## Acceptance criteria - [ ] Every topic above has a page or section, with screenshots where text alone isn't enough - [ ] `zensical build --strict` passes
Author
Owner

User handbook written in #145: Reading guides and Writing guides, illustrated with the #140 screenshots. Columns are page-only in kataba, so the handbook documents guides' rich text without them and attachments under the Media tab. zensical build --strict passes.

User handbook written in #145: Reading guides and Writing guides, illustrated with the #140 screenshots. Columns are page-only in kataba, so the handbook documents guides' rich text without them and attachments under the Media tab. zensical build --strict passes.
miko closed this issue 2026-11-06 11:31:10 +01:00
Sign in to join this conversation.
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
MassiveDynamic/kataba#141
No description provided.