z – Placeholder App
Template for Enterprise App documentation. Duplicate this tree for each app; replace instructional text with product content.
Parent: Enterprise Applications
Documentation map
Page | Purpose |
|---|---|
What it solves; main features & stories | |
Short capability list | |
Who benefits and how | |
Click-through guides | |
App acceptance checklist | |
Go-live: who brings what |
Filled examples: Prime Property · Prime Product
Learnings for authors & agents (keep this)
Use this section when creating or updating any Enterprise App doc tree. Last confirmed: 2026-07-30.
Page tree & titles
Exactly six sub-pages under the app hub (plus optional legacy install deep-dive after the six).
Titles:
Section (App)e.g.Overview (Prime Product)— Confluence requires unique titles space-wide; section name leads for readability.Hub lives under Enterprise Applications.
Child page order (mandatory)
Sidebar order under every app hub must be exactly:
Overview
Feature List
User Stories
Official Documentation
Unit Test Protocol
On Boarding Steps
Parallel createConfluencePage assigns random positions — creation batch ≠ tree order. Parent moves via updateConfluencePage do not reliably reorder siblings.
After creating children:
Verify in the Confluence left page tree (and/or descendants
childPosition), not by page id.Prefer Confluence move API:
PUT .../wiki/rest/api/content/{id}/move/before|after/{targetId}.MCP workaround: archive/rename old pages, then create the six pages one-by-one in schema order so
positionincreases; hide anyzzz-reorder-binunder On Boarding and delete archives in the UI.Never ship an app hub with wrong sibling order.
Voice & length
Customer / delivery facing — operators, planners, CS, delivery.
Short. Prefer one screen per page where possible.
No heavy coding language: avoid MVC, DEL/FR IDs, epic IDs, class/path dumps on public pages.
No competitor rebuild kit: algorithms, provider chains, seed mechanics, deep data models.
Seeding: optional ops aid only — not a focus.
Content by page
Page | Do | Don’t |
|---|---|---|
Overview | Problem, personas, main features/stories, at-a-glance | Epic numbers, engineering status |
Feature List | Short capability table + out of scope | Trace IDs, backlog status |
User Stories | 5–8 plain-language stories; “Done when” | Paste roadmap 1:1; internal IDs |
Official Documentation | Short click-throughs; screenshots TBD OK | Architecture essays |
Unit Test Protocol | Short checklist + process links + sign-off | Full test suite paths |
On Boarding | Top deliverables then scopes | Long phase catalogues |
User stories source
Orient on roadmap / epic themes; rewrite into operator language; never backlog 1:1.
On Boarding structure (strict)
Top customer deliverables — 3–5 items, priority order.
Scopes — max 3–5 (Access · Decisions · Initial data · Acceptance).
Per scope: NMS brings / Customer brings / Decide.
Install
On the app hub; optional deep install after the six — not a 7th schema page.
UAT layers
App Unit Test Protocol = does this app work?
UAT & ISP Processes = can the ISP run the business?
Internal mapping (agents only — not on customer pages)
App | Epic / module | Hub ID |
|---|---|---|
Prime Property | EPIC-002 · |
|
Prime Product | EPIC-001 · |
|
Placeholder App | template |
|
Publishing notes (agents)
cloud
nmsprime.atlassian.net, space NMS (8519680), parent8533315.contentFormat: "markdown".Wire hub doc map to real URLs; always reorder before done.
Install & enable (pattern on every app hub)
Package / how to enable
Required companion apps
Link to longer install note only if needed
How to duplicate for a new app
Create hub under Enterprise Applications.
Create six children sequentially in schema order (
Section (App)titles).Verify tree order; fix if needed (see Child page order).
Fill Overview → Features → Stories → Docs → UAT → On Boarding (Top deliverables first).
Link Unit Test Protocol from UAT & ISP Processes when ready.