Readiness Map docs

Readiness Map installs from the Atlassian Marketplace and runs entirely inside Jira. There's nothing to host and no account to create.

1. 1Install Readiness Map from the Atlassian Marketplace (or your private listing link).
2. 2Open it from your Jira apps. It runs as a page inside your site.
3. 3A fresh install starts from the sample content the app ships with, so you can explore before adding your own work.
4. 4Start your own work with "+ new flow", the last entry in the flows picker at the top.

There's one installation per Jira site, and nothing to switch between. New work is a new flow, not a new install.

• Component: one build component, held once in the register with an ID and a description of what it is.
• Flow: a diagram of how components work together, laid out across columns (stages). A flow has a name, a purpose, and the business rules it runs under, and it points at a Jira ticket of any type, or at a project key when no single ticket covers the work.
• Register: every component ID, what it does, which flows it appears in, and its Jira position. A component that appears on two flows, or twice on one, is one entry drawn everywhere it takes part.
• Notes: actions, questions, and findings that don't have a Jira ticket yet. Everything else the app shows belongs to Jira.

Readiness Map opens as a page in Jira with a tab for each view. Use the flows picker in the header to open any flow's diagram.

• Summary: totals across every flow (components, placements, components shared across flows, connectors, open tickets, how many are confirmed complete, and how many aren't accounted for), plus a card for each flow.
• Jira issues: every Jira issue linked to a component. Filter by delivery version, status (To do, In progress, Done), or component, or search by key, summary, or component, then open the issue in Jira.
• Register: every component ID, what it is, which flows it appears in, and whether its tickets are done. Click a flow name to jump to that component in its diagram.
• Notes: findings, questions, and blockers. Filter by status, kind, severity, origin, or topic, sort them, and edit them in place.
• Document: download a read-only HTML file for people who won't open the app.
• Settings: which Jira projects are read, backup and restore, and appearance.
• About: a guide to the app, and the build stamp for support requests.

• Shaded bands are the columns (stages), left to right.
• Each solid box is a component from the register, with its ID and a small icon for what kind of thing it is, such as an API, pipeline, store, or report.
• Dashed boxes are things outside the register, such as a source system, a manual step, or an open question. They have no ID.
• Arrows are connections between boxes and can carry a label, such as "Read".
• Reports, notifications, monitors, error logs, and dashboards sit in a band beneath the diagram. A box connected to one of them carries a small glyph in its corner instead of an arrow; click the glyph to jump to that item.
• Ticks show completion: hollow means every Jira ticket is closed but nobody has confirmed it, solid means closed and confirmed, and an exclamation mark means it was confirmed and then the work changed.

• Add a box: press + on the column you want. Pick a component already in the register, one Jira has that the register doesn't, or a new one.
• Move a box: drag it to another column or row, or type its position in its panel. A drop isn't saved until you confirm it in the strip under the diagram; say no, or leave the flow, and it goes back.
• Two boxes can't share a spot. The target turns red before you let go. To put two boxes side by side, drag one onto the other and the column widens to hold both.
• Make space in a full column: open the box that should end up below the gap and use "push down". It and everything under it in that column move down one row.
• Add a component part-way along a connection: open either box, go to Connections, and press "+ box between" on the arrow joining them.
• Connections: a box's Connections tab lists both directions. Reverse an arrow, remove it, or set which side it leaves and enters and which row it travels along.
• Rename or remove a column: click its header. A column can only be removed once it's empty, so it can never take boxes with it.
• Change what a flow is: use the pencil beside its title to edit its name, purpose, what it points at in Jira, and its columns. The requirements panel below the diagram holds the rules it runs under.
• Correct a box's type: the icon is guessed from the name. Set Type on the box to change it, and your value always wins. Setting a type of Report, Notification, Monitoring, Error log, or Dashboard moves the box into the band.

• Components to tickets: through Jira's own Components field. Name each Jira component with its ID in front of what it is. The app matches on the ID, so renaming the rest of it in Jira is safe.
• Components are per project, so each one has to exist in every Jira project the work lives in.
• Projects read: whatever your flows point at, plus any you add on the Settings page. Adding one is additive; clearing the box doesn't stop the others being read.
• Delivery version: choose a version and every count and tick rescopes to it. A component is complete for that version when its work for that version is done.
• A ticket Jira doesn't link: open the box, go to Jira, and pin the ticket's number under "pinned by hand". It counts the same as a linked one. Use this for work that carries no component ID, or for a box outside the register.
• Until an issue names a component, that component shows no Jira work.

The Document tab builds a single HTML file for people who won't open the app. It includes every flow you select, each with its diagram, purpose, business rules, assumptions, and components, plus the register for those components and where each stands in Jira.

• Pick which flows to include. The register and figures narrow to match.
• Diagrams are embedded, so the file opens with no network. It's safe to email or keep on a shared drive.
• To make a PDF, open the file and print to PDF. Each flow starts on a new page, and no diagram is split across pages.
• Jira figures are a snapshot from the moment you downloaded the file, and the file says so.
• Notes are never included. They stay in the app.

The file is created in your browser and saved by you. The app doesn't send it anywhere.

There's no undo. Every edit is saved as you make it, so take a backup before reorganizing a flow. In place of an undo, nothing destructive happens on a single click: deleting a box, a connection, a note, or a requirement section always asks first, and a box tells you how many arrows it will take with it.

• Back up: in Settings, choose "download everything" to save the whole workspace as one JSON file.
• Restore: choose the file in Settings and restore it. A backup is always the whole workspace, and restoring replaces everything, so a file holding half the workspace would delete the other half.
• Who can restore: anyone who can open the page, until you limit restoring to the "readiness-map-admins" Jira group.
• Moving between sites: a fresh install on another site starts from the sample content, so restore a backup to move your work across.
• To share your work with someone, send the Document export, not the backup.

• Which Jira projects are read: list extra project keys. Projects your flows point at are always read.
• Backup: download and restore the whole workspace, and limit who can restore.
• Appearance: light or dark, remembered in your browser. It follows your system setting until you choose one.

• Where it lives: in Forge storage inside your own Atlassian site. Nothing is sent anywhere else; the app declares no outbound network permission at all.
• What it can see: Jira issues you could already see, read under your own permissions, and which Jira groups you're in (which decides who may restore a backup).
• Getting a copy out: Settings gives you the whole workspace as a file you can restore, and the Document tab gives you a read-only HTML file. Both are files you download yourself.

See the Security & Data Handling page for the full detail.

• A component shows no Jira work? Check that a Jira component named with its ID exists in the project the work lives in, that the issues carry that component, and that the project is read (a flow points at it, or it's listed in Settings).
• Counts look low? Check the delivery version selected; choosing one rescopes every count and tick.
• Not seeing an issue you expect? The app reads Jira as you, so it only shows issues you have permission to view.
• A box went back after you moved it? Moves are saved only once you confirm them in the strip under the diagram.
• Need the exact version you're running? The About page shows a build stamp; include it in support requests.

Does Readiness Map write to my Jira?

No. Not a ticket, not a field, not a component. Everything you change is kept in the app.

Does my data leave Atlassian?

No. The app declares no outbound network permission, and your workspace stays in Forge storage in your Atlassian site. The only copies that leave are files you choose to download yourself: the Document export and the backup.

Can I undo a change?

There's no undo, so take a backup from Settings before a big reorganization. Nothing destructive happens without a confirmation.

Can I move my work to another Jira site?

Yes. Download a backup from Settings on the old site and restore it on the new one.

What does it cost?

It's free during early release. If paid plans are introduced later, existing installs get advance notice.