Sign in to create and edit playbooks. Sign In Register

Define Information Architecture

ESM-3 Order: #3 Inception Has Dependencies

Updated 1 month, 2 weeks ago

Guidance

Define Information Architecture

Objective

Establish the design system foundation, layout patterns, and component standards.

Artifacts Created

  • docs/ux/IA_guidelines.md - Information architecture and design system

Process

1. Define Information Architecture

  • Document design system foundation (Bootstrap 5.3+ base)
  • Define design tokens (colors, spacing, typography, shadows, borders)
  • Establish layout patterns (2-column, 3-column, grid, forms)
  • Define navigation structure (top navbar, breadcrumbs, tabs)
  • Document component patterns (cards, buttons, forms, modals)
  • Specify accessibility requirements
  • Define icon system (Font Awesome Pro)

Philosophy: Leverage Bootstrap's conventions, utilities, and component patterns as the first choice. Customize only when necessary for brand identity or specific user experience requirements.

Key Sections to Document

1. Design Tokens

  • Color palette (primary, secondary, custom colors)
  • Spacing scale (Bootstrap multipliers)
  • Typography (font stacks, sizes, weights)
  • Shadows and borders

2. Layout Patterns

  • Dashboard grids
  • Form layouts
  • List/table views
  • Detail pages

3. Navigation Design

  • Top navigation structure
  • Breadcrumbs
  • Tab navigation
  • Active states and ARIA attributes

4. Component Patterns

  • Cards
  • Buttons (with Font Awesome icons and tooltips)
  • Forms and inputs
  • Modals and dialogs
  • Tables
  • Empty states

5. Page Header Pattern

Document the canonical structure for every non-dashboard page: breadcrumb row, title + action cluster row, and (for detail pages) a metadata sub-row. Specify which information belongs in each row, how the action cluster is composed, and how it adapts between list, view, and edit contexts.

6. Baseline CRUDLF Page Templates

Document the skeleton layout for each standard screen operation: List+Find, View, Edit, and Delete. For each, specify the column split, which organisms compose the main area, what the sidebar (if any) may contain, and whether the operation uses a full page or a modal.

7. Button Placement Rules

Document as a decision table: for each context (list page header, form footer, detail page with destructive action, modal footer) — which corner holds the action cluster, and what is the left-to-right order of buttons within it. State the universal rules that apply across all contexts (e.g. primary always rightmost; destructive always leftmost in its cluster).

8. Feedback / Notification System

Document the chosen mechanism for each feedback type: success, error, warning, info, and field validation. For each, specify the UI component used, its positioning, dismissal strategy (auto-dismiss with timing vs. manual), and how backend operations surface feedback to the frontend (e.g. response headers, HTMX events, Django messages framework).

9. Component State Catalogue

For every interactive component, document all states: default, hover, focus, active, disabled, and loading. List the minimum set of components that must be covered. Specify the visual treatment (CSS class, style change, or animation) for each state and note any accessibility requirements (e.g. visible focus ring, aria-disabled).

How to Execute This Step

1. Plan Before Executing

  • Identify all design system components needed
  • Reference existing Bootstrap documentation
  • Note Mimir-specific customizations
  • Show plan and get approval

2. Work Incrementally

  • Document one section at a time
  • After every section: write → review → refine
  • Build incrementally: tokens → layouts → navigation → components → page patterns → CRUDLF templates → button rules → feedback → states

Deliverables

  • ✅ IA guidelines with design system specifications
  • ✅ Screen ID convention documented: Format, CRUDLF operations, examples
  • ✅ Navigation structure defined
  • ✅ Layout patterns documented
  • ✅ Component patterns with accessibility requirements
  • ✅ Icon system (Font Awesome Pro) documented
  • ✅ Bootstrap customization approach clear
  • ✅ Page header pattern documented (breadcrumb / title + action cluster / metadata sub-row)
  • ✅ Baseline CRUDLF templates documented (List+Find, View, Edit, Delete)
  • ✅ Button placement rules table documented
  • ✅ Feedback system documented (mechanism and dismissal strategy per feedback type)
  • ✅ Component state catalogue documented (all states for all required components)

Responsive Coverage Contract

Responsive support is an explicit design and verification contract, not a generic instruction to "make it responsive." Define all dimensions in CSS viewport pixels used by the browser test context.

Required viewport matrix

Profile Viewport Bootstrap width tier Design risk
Wide, low-height desktop 1280 x 800 xl Limited vertical space despite desktop width
Large 16:9 desktop 1920 x 1080 xxl Excess width and long line lengths
14-inch MacBook Pro reference 1512 x 982 xxl Laptop-density layout
9.7-inch iPad portrait 768 x 1024 md Tablet stacking and touch targets
9.7-inch iPad landscape 1024 x 768 lg Wide but vertically constrained tablet
Representative phone portrait 390 x 844 xs Primary phone layout
Minimum supported phone portrait 360 x 800 xs Narrow-phone boundary

The IA may add project-specific profiles but must not silently remove or weaken these baselines. Device pixel ratio, physical panel resolution, and device marketing names do not replace the CSS viewport dimensions.

Page-layout recipes

Define reusable responsive recipes for every page archetype used by the Screen Flow, including dashboards, LIST+FIND tables, entity VIEW pages, collection VIEW pages, create/edit forms, delete/confirmation surfaces, split-pane or canvas screens, and full-viewport screens.

Each recipe specifies, for every target viewport or applicable width/height class:

  • container width, columns, and stacking order;
  • navigation collapse and breadcrumb behavior;
  • title, metadata, and action-cluster wrapping;
  • table/card transformation and intentional local overflow;
  • sidebar, context rail, split-pane, canvas, modal, and drawer behavior;
  • readable line length and use of surplus width;
  • vertical scrolling, sticky regions, and primary-action reachability on low-height screens;
  • touch-target, focus-order, and keyboard behavior.

Every Screen ID must map to one named page-layout recipe. A screen that behaves differently must document the exception at each affected viewport. Mapping to a shared recipe is an explicit layout definition and does not require unique CSS for every page.

Universal visual acceptance rules

At every target viewport:

  • no unintended page-level horizontal scrollbar appears;
  • text, controls, menus, tooltips, modals, and feedback are not clipped or overlapped;
  • primary navigation and the screen's primary action remain reachable;
  • reading order and keyboard focus order remain coherent after stacking or collapse;
  • tables and other intentionally scrollable components contain overflow inside their documented wrapper;
  • content remains readable without browser zoom;
  • low-height layouts permit deliberate vertical scrolling unless the documented recipe is full-viewport, in which case the viewport-fit behavior is tested explicitly.

Evidence and traceability

The IA Guidelines contain the viewport matrix and recipe catalogue. Maintain a coverage table mapping every Screen ID to its recipe and any exception scenarios. ESM mockups and BPE journey tests use the same profile names and dimensions so design evidence, Gherkin, screenshots, and implementation results remain traceable.

Details
Order:
#3
Phase:
Predecessor:
ESM-2 Define User Journey
Created:
Apr 11, 2026
Last Updated:
Sep 22, 2026
Workflow
Envision the System

Turn your vision into formal design artifacts - user journey, screen flow, mockups, feature files, and design system

View Workflow
Assigned Agent

No agent assigned

Rules
Input Artifacts

No input artifacts

Output Artifacts 2