Millarum PRD User Manual

Transform raw Jira Epics, Features, and User Stories into executive-ready Product Requirements Documents with auto-section numbering, live editing, and 1:1 PDF exports.

✓ Jira Cloud ✓ Auto Section Numbering ✓ Rich Text & Images ✓ Saved Views & Presets ✓ 1:1 PDF Export ✓ INCOSE Quality Checks

📊 1. Core Concept Overview

Millarum PRD compiles standard Jira Cloud issues into structured, executive-level Product Requirements Documents (PRDs). Rather than copy-pasting issues into external word processors, Millarum PRD directly pulls your live Jira hierarchy and renders it as standard US Letter pages complete with cover page, Table of Contents, automatic section numbers, inline rich text images, status pills, and requirement quality indicators.

Capability	Description
Automatic Tree Compilation	Constructs multi-level document trees from Jira parent-child links (Epics → Functional Areas → Tasks).
Native Live In-line Editing	Edit issue summaries and ADF rich text descriptions natively inside the document view without context switching.
Saved View Configurations	Save named filter configurations, custom section orderings, TOC levels, and quality checks for 1-click loading.
INCOSE Quality Checking	Automated checks for requirement ambiguity, passive voice, missing metric targets, and vague language.
Pixel-Perfect PDF Export	Generate standard 816px × 1056px US Letter PDFs with Base64 embedded images, zero content truncation, and visible footers.

🛠️ 2. Installation & Setup

Millarum PRD is built natively on the Atlassian Forge Cloud platform and installs into any Jira Cloud instance with zero external server dependencies.

Install from Marketplace
Search for Millarum PRD on the Atlassian Marketplace and install it to your site.
Access from Project Sidebar
Open any Jira Software or Jira Service Management project and click Millarum PRD in the left-hand navigation.
First Document Render
Millarum PRD automatically loads the project's issues, builds the requirement hierarchy, and displays your compiled document instantly.

Security Guarantee

Millarum PRD operates strictly within your Atlassian site boundaries using Atlassian Forge security models. All data requests execute under your user context (.asUser()), ensuring users only see issues they have permission to access in Jira.

📄 3. Document View vs. Edit Mode

Millarum PRD features two operational modes tailored for reading and editing requirements:

Mode	Primary Use Case & Capabilities
Document View Mode	Clean reading and executive presentation view. Hides interactive edit controls and displays requirement quality pills (e.g. `80%`), status badges, formatted tables, images, and section numbers.
Edit Mode	Interactive editing view. Displays edit buttons on requirement paragraphs. Plain text items can be edited directly in-line, while complex ADF rich text elements (images/tables) provide direct edit links to Jira native editors.

🌳 4. Hierarchy & Tree Ordering

Millarum PRD maps Jira issue relationships into four document hierarchy levels:

Level 0 (Major Section): Top-level Epics or primary functional modules. Rendered as large document headings.
Level 1 (Functional Area): Secondary requirement categories linked under Level 0 parent issues.
Level 2 (Feature Specification): Specific system capabilities or components.
Level 3 (Requirement Task): Granular functional requirements or implementation stories.

Custom Section Ordering

Open Document Settings → Tools → Reorder Sections to drag and drop functional areas into any custom sequence. Your custom order is automatically preserved when saving views!

📑 5. Section Numbering & Table of Contents

Millarum PRD automatically generates formal section numbering before each title line (e.g., 1., 1.1., 1.1.1., 2.):

Automatic Recalculation: Section numbers recalculate dynamically whenever filters are applied or sections are reordered.
Dynamic TOC Pagination: The Table of Contents paginates entries dynamically based on item line height (820px ceiling limit), preventing orphan entries and empty gaps.
Configurable TOC Depth: Toggle TOC levels on/off or filter by specific hierarchy levels inside Document Settings.

🔍 6. Filters & Saved Views

Customize your PRD content using built-in filters and persist your exact setup into Saved Views:

Issue Type & Status Filtering
Select specific Jira issue types (Epics, Stories, Tasks) or statuses (In Progress, Done, To Do).
Saving a New View
In Document Settings → Saved Views, enter a view name and click Save Current View.
Overwriting Existing Views
Select an existing saved view from the dropdown and click Overwrite View to update its configuration.

Complete State Savings

Saved views store all document settings, including active filters, custom section order, TOC depth configuration, and quality check enablement.

🛡️ 7. INCOSE Quality Checks

Ensure your requirement specifications adhere to international engineering standards. Millarum PRD evaluates requirement text against INCOSE (International Council on Systems Engineering) quality rules:

Rule Category	Detection Pattern & Remediation Advice
Ambiguous Words	Flags vague terms like "user-friendly", "fast", "flexible", "robust", or "easy". Recommends quantitative metrics.
Passive Voice	Detects passive constructs (e.g. "is processed by"). Recommends active voice (e.g. "The system processes...").
Missing Metrics	Highlights requirements lacking measurable thresholds or timeframes.

Quality scores (60%, 80%, 100%) appear as color-coded pill badges next to each requirement title in document view mode.

📥 8. Exporting to PDF & Printing

Export your compiled document to standard US Letter PDF with one click:

Click Export PDF
Click the Export PDF button in the top document header.
Base64 Pre-Conversion
Millarum PRD automatically converts all Jira attachment images into inline Base64 data URLs to guarantee CORS-safe rendering.
Locked Footers
Footer page numbers (Page X of Y) remain locked at the bottom of every page with zero content truncation.

💡 9. Best Practices & FAQ

Best Practice Tip

Group your requirements in Jira using standard Epic links or parent-child relationships. This enables Millarum PRD to compile clean multi-level section numbers automatically!

Frequently Asked Questions

Q: Can I customize section numbers?
A: Section numbers are computed automatically based on your tree structure and custom section order. Reordering sections in Document Settings instantly updates section numbers.

Q: Is my data safe?
A: Yes! All data processing occurs inside Atlassian's secure cloud sandbox using .asUser() context. No requirement data is ever transmitted to third-party servers.