Documentation roadmap
Planned work for turning this foundation into complete product documentation.
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.
Content rules
Section titled “Content rules”Every guide should:
- state the outcome in its title and opening sentence;
- identify prerequisites before the procedure;
- use the exact labels shown in the interface;
- explain only the concepts needed to complete the task;
- include expected results and a short recovery section; and
- link to the generated API reference instead of duplicating endpoint schemas by hand.
Next pages to add
Section titled “Next pages to add”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.
Screenshot checklist
Section titled “Screenshot checklist”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.