M2-11 User Documentation / Help System¶
Milestone: M2 — Platform and Client Admin SOW Reference: FR6 Requirement Clarity: 🟡 SOW doesn't name a tool; the original v3 doc specified Zendesk as the delivery mechanism — confirm whether that's still expected or a custom in-app solution is acceptable Dev Status: ❌ Not started
Overview¶
Make user-facing guides/tutorials available within the system. Per the SOW, the content is authored by the JVP — NeuralRays is only responsible for the implementation/delivery mechanism.
Backend Tasks¶
- If Zendesk: implement the widget/SSO integration
- If custom: build a simple content-delivery endpoint (static markdown/CMS-backed help articles)
Frontend Tasks¶
- Add a help/documentation entry point in the app shell (e.g. a "?" icon or Help menu item)
- Contextual help links on key screens (KYB, credential issuance, disclosure)
Dependencies¶
- Content itself comes from the JVP — this task blocks on receiving that content, not just building the delivery mechanism.
Acceptance Criteria¶
- User documentation accessible (per SOW Appendix 3, FR6 acceptance criteria)
Existing Reference Material¶
Blockers & Risks¶
- Needs decision: tool choice (Zendesk vs. custom) changes the effort here materially — resolve before estimating.