Documentation Map
Updated 9 September 2026
Support Workflow Release · 9 September 2026: These steps match the deployed application. Screenshots use fictional local data. Live multi-staff acceptance and production rollout remain separate gates.
The staff and administrator guides describe the technical demonstration and current local build. The feasibility report and engineering checklist describe the wider decision and remaining work. Do not use a historical test count as the current release total.
Choose a Document
| Reader | Canonical Source | Purpose |
|---|---|---|
| Studio Operator | docs/STUDIO-GUIDE.md |
Discovery, maps, agent publication, preview, stop and evidence export. |
| Demo Presenter | docs/DEMO-SCENARIOS.md, docs/STAGES-2-4.md |
Portable fictional pack, eight scenarios and the Stage 2–4 scope. |
| Support Operations Administrator | docs/SUPPORT-SETTINGS.md |
Routing, signatures, canned replies, configured directory, channel policy and held-message review. |
| Platform Operator | docs/PLATFORM-ADMIN.md |
Staff access, policy, usage limits and separate administration sign-in. |
| Policy Reviewer | docs/DATA-USE.md |
Purpose-specific decisions, evidence and withdrawal. |
| Support Staff | docs/STAFF-GUIDE.md |
Daily queue, shared assignment, reply, transfer, resolution and history permission. |
| New Administrator | docs/SETUP.md |
Ordered Microsoft, WhatsApp, LINE, WeChat and reviewer setup. |
| Operating Administrator | docs/OPERATIONS.md |
Rehearsal checks, incidents, credentials, backup and release recovery. |
| Staff and Supervisor | docs/FEEDBACK.md |
Case-linked suggestions, decisions and period report definitions. |
| Profile User | docs/PROFILES.md |
Evidence, verification, explicit links and corrections. |
| Supervisor | docs/ESCALATION.md |
Supervisor Actions, shared recovery and earlier escalation decisions. |
| Knowledge Owner | docs/KNOWLEDGE.md |
Review, expiry, source evidence, revision and controlled reuse. |
| Deployment Engineer | docs/NATIVE-DEPLOYMENT.md |
Isolated process, filesystem, proxy and Teams SSO layout. |
| Channel Administrator | docs/LINE-PILOT.md, docs/WECHAT-PILOT.md |
Verified channel paths and limits. |
| Sponsor | docs/FEASIBILITY.md, docs/NEXT-SLICE.md |
Feasibility, original vision boundaries and recommended next scope. |
| Tester | docs/TEST-EVIDENCE.md |
Dated evidence, clearly separating local checks and live results. |
| Delivery Team | docs/TODO.md, docs/ENGINEERING-TODO.md |
Short human actions and detailed engineering backlog. |
Historical cut notes retain their date and test counts. Stages 1–4 are deployed as a technical demonstration; that baseline has 60 passing application tests plus four UI/layout checks and a real Teams-to-WhatsApp rehearsal. The support workflow is now deployed; docs/SUPPORT-EVOLUTION.md records its current checks and remaining real-access decisions. The guides describe its matching builder, support and quota controls. Public website checks are separate from transport tests.
Build the Website
-
Edit the canonical Markdown source in
docs/. Do not edit generated guide HTML. -
Use a Python environment with
python -m pip install -r scripts/docs-requirements.txt. -
Run
python scripts/build_guides.py→python scripts/check_guides.py. -
Preview
public/guides/through a local static server or the loopback demo. The guide home is/guides/; staff and setup pages arestaff.htmlandadmin.html. -
Review both guides at desktop and narrow widths. Use the browser's Print command for a clean printable copy.
-
Publish only
public/guides/at the site's/guides/path. Link it from the public homepage and the Inbox User Guide link. Serving these files does not enable access to Inbox APIs.
The generator uses an explicit source allowlist of 20 documents plus the guide home. It includes Studio, Demo Scenarios and Stages 2–4 alongside staff, administration, operations and the earlier technical guides. It does not publish the source ZIP, feasibility PDF, original vision PDF, private handoffs, environment values or the repository root.
The administrator guide includes a simple Architecture and Data Flow Diagram. Its editable vector source is docs/images/data-flow.svg; it is separate from the UI screenshots. The Studio Data Flow is docs/images/studio-data-flow.svg and shows discovery through human send and bookkeeping.
Screenshot Rules
Screenshots in docs/images/ come from the actual local Inbox, Administration and Studio UI with fictional data. The set includes Deploy and token quota views for the local support-workflow release. The guide generator preserves their actual dimensions. No live customer or tenant screen was used. They illustrate controls and workflow, not independent evidence of provider delivery.
| Image | What It Shows |
|---|---|
support-settings.png |
Current central support settings with fictional configuration. |
ai-feedback.png |
A staff suggestion awaiting central review. |
persona-import.png |
Markdown definition preview before importing a working draft. |
studio-discovery.png |
Fictional sources, permissions and discovery candidates. |
studio-map.png |
Editable 2D responsibility flow and evidence inspection. |
studio-3d.png |
Interactive Three.js view of the same graph. |
studio-knowledge.png |
Knowledge owners, review dates and expiry queue. |
studio-builder.png |
Centrally managed persona, knowledge, process and tools. |
studio-deploy.png |
Channel configuration and publication status. |
studio-token-quota.png |
Consumed, reserved and remaining model-token quota. |
studio-evaluate.png |
Evaluation scenarios and publication readiness. |
studio-revisions.png |
Saved changes before publication. |
studio-draft-preview.png |
Never-sendable working-draft test configuration. |
studio-evaluation-comparison.png |
Latest scenario attempts across published revisions. |
studio-preview.png |
Published-revision preview and readiness checks. |
studio-ledger.png |
Run mode, outcome, usage and decision bookkeeping. |
ai-review.png |
Fictional AI suggestion, source evidence and explicit review. |
retention-review.png |
New retention review with fictional case scope. |
capture-exclusion.png |
Platform capture decisions for a fictional customer. |
workspace-registry.png |
Planned isolated deployments with fictional metadata. |
pilot-evidence.png |
Aggregate observations and baseline comparison from fictional samples. |
data-use.png |
Separate knowledge/AI decisions and evidence. |
platform-admin.png |
Platform capabilities and daily usage limits. |
staff-access.png |
Staff roles and offboarding with fictional employees. |
shared-support.png |
Local shared assignment, queue and composer. |
transfer-ticket.png |
Receiving staff, transfer reason and reviewed summary. |
resolve-ticket.png |
Reviewed resolution and case-study nomination. |
history-permission.png |
Customer permission for named staff to view prior conversations. |
inbox-mobile.png |
Phone transcript with fixed navigation and reply bar. |
inbox-mobile-reply.png |
Phone reply editor with customer/internal separation. |
inbox.png |
Current Outlook-style queue and composer. |
internal-note.png |
Amber team-only composer and saved internal note. |
handover.png |
Earlier single-owner handover controls; not the new Transfer flow. |
case-context.png |
Summary, tags and knowledge nomination. |
knowledge.png |
Centrally managed approved answer and insertion into a staff reply draft. |
agent-reply.png |
Fictional booking draft, agent selection and human review before sending. |
customer-profile.png |
Verified/unverified facts with source evidence. |
profile-link.png |
Explicit identity-check confirmation before linking. |
escalate.png |
Earlier escalation form; new manager requests use Transfer. |
recovery.png |
Earlier single-owner recovery; replace before illustrating shared recovery. |
service-report.png |
Current backlog and selected-period activity using fictional data. |
feedback-create.png |
Fictional staff suggestion with a source message. |
feedback-review.png |
Supervisor decision and its review history. |
The support settings, shared assignment, transfer, resolution, history permission, AI Feedback and persona import screenshots were captured and visually inspected for this edition. Transfer also passed a narrow-screen overflow check.
Keep the Local Workflow Preview label visible. Inspect all screenshots before publishing. Do not capture passwords, tokens, account IDs, phone numbers, tenant chrome or unreviewed customer messages. Administrator screenshots deliberately show expected application results; vendor portal links and precise written steps cover provisioning without exposing a live tenant.
Release Checklist
-
Confirm labels against the UI and tests against the release evidence.
-
Build/check the guides and inspect their output; ensure every local link resolves and every image has useful alternative text.
-
Run
npm testwhen app files change. No transport claim follows from a docs-only change. -
Keep the edition date at 9 September 2026 for this local workflow cut. Label deployment and live acceptance separately. Update the dated evidence and engineering checklist. Record private deployment details only in the private handoff.
-
Run
python scripts/package_solution.pyand the private package scan. Keep the package for controlled sharing rather than putting it on the public web root. -
Commit with a Conventional Commit. Do not add a remote or push without a request.
Microsoft-Style Guides
Hosted guides use a topic sidebar, title filter, article breadcrumbs and an On This Page navigation. Appearance supports System, Light and Dark. On phones, both navigation sections collapse above the article. Browser printing removes navigation. The guide shell uses OCDIT branding and does not load Microsoft scripts or analytics.
Client Rollout covers Azure, Microsoft 365 access and the Azure AI feasibility boundary.