Create a review pack (PDF)
A review pack is one PDF that a reviewer can read without iyedy: a cover with the title block, one page per view, then the tables a review needs. In an organisation it is the Review dossier; on a personal account, the Sign-off pack.
On this page
Before you start
- A diagram open in the editor, with the views you want to show. Anyone who can open the diagram can make its pack.
- For the findings tables, run the checks first (Run the checks), so the pack lists today's findings.
Make the pack
- Open Export
Press Ctrl E. In the Dossier group, select Review dossier, or Sign-off pack on a personal account.
- Choose what goes in
The dialog shows the pack's main parts, each ticked by default:
- Views (4 of 7): the views of the template, here Context, Containers, Deployment and Data flow;
- Findings: the findings with their severity and status;
- Comments: the review threads;
- History: the revisions.
Untick what the reader does not need.
- Export it
Select Export the dossier. iyedy renders each view, writes the PDF and saves it.
More options
Select More options… for the full dialog, also open from the palette with Export review dossier (PDF)… or Export sign-off pack (PDF)…:
| Part | Choices |
|---|---|
| Template | Review dossier (or Sign-off pack): views, interfaces, quality requirements, decisions, risks, findings, revisions and sign-off. Architecture description: the twelve arc42 sections, with the views filed under context, building blocks, runtime and deployment |
| Sections | tick the sections to print; the summary is always included. Narrative sections take a text of yours, and Draft text asks the Assistant for a first version you edit before the PDF |
| Options | Paper for views: A4 or A3; Include dismissed findings |
| File name | the name of the PDF; iyedy proposes one from the diagram, the pack and its revision |
| Views, one page each | tick the views one by one, or Select all, None, Template views |
Then select Download PDF, or Export nothing to close.
What the pack contains
- The cover: the title block of the diagram, with its title, document id, revision, date, author and status stamp.
- One page per view, drawn as on screen, with the view's layers.
- The review tables: interfaces (protocol, port, authentication, encryption, data classification), quality requirements, decisions, a risk register on a likelihood and impact matrix, findings with severity and status, revisions and the sign-off.
- Drafts of the Assistant you attached print labelled as proposed, never as decided.
The file name is never below the diagram's classification: a pack that holds Confidential views says so in its name. Send it only to people who may read that level.
If it doesn't work
Views (0 of 7) cannot be ticked
The template's views are not in this diagram yet. Select More options… and tick the views you have under Views, one page each.
“Dossier not built”
A view could not be rendered. Open each view once to check it draws, then export again. If it persists, write to support@iyedy.com with the time and the diagram's name.
“Downloads are not available here.”
Your browser blocked the download. Allow downloads for app.iyedy.com, then export again.
More symptoms in Import and export troubleshooting.
Was this page helpful?Your answer is anonymous and counts only if you accepted measurement.
What went wrong?
Don't write personal data.