Skip to content
Open BisQue

Documentation roadmap

Planned work for turning this foundation into complete product documentation.

View as Markdown

This section is the public, task-oriented documentation for BisQue. Maintainer design records, architecture notes, and migration plans remain outside it so users do not have to navigate implementation history to complete a task.

Every guide should:

  1. state the outcome in its title and opening sentence;
  2. identify prerequisites before the procedure;
  3. use the exact labels shown in the interface;
  4. explain only the concepts needed to complete the task;
  5. include expected results and a short recovery section; and
  6. link to the generated API reference instead of duplicating endpoint schemas by hand.

The highest-value additions are:

  • image viewer controls for channels, planes, projections, and comparisons;
  • graphical annotation tools and keyboard interactions;
  • dataset creation and membership management;
  • tag search and semantic-type search examples;
  • project cards, sharing, and collaborator roles;
  • export formats and asynchronous export jobs;
  • model and module packaging tutorials;
  • production deployment, object storage, backup, and upgrade guides; and
  • troubleshooting pages based on real support questions.

Add focused screenshots after interface labels stabilize. Capture one action per image, crop out unrelated browser chrome, use non-sensitive sample data, add descriptive alternative text, and retake screenshots when the corresponding workflow changes. Prefer annotated screenshots only when a reader would otherwise struggle to find the control.