Document Management

Upload, parse, organize, and link your project documentation.

Uploading Documents

All project documentation lives on the Documents page, accessible from the left-hand sidebar of your project.

To upload a document:

1. Navigate to Documents in the project sidebar.
2. If you want to organize the file into a folder, create or select a folder first (see Folder Organization below).
3. Click Upload in the toolbar and select one or more files from your computer.
4. AIRGen accepts Word (.docx) and PDF files.
5. Once the upload completes, AIRGen automatically parses the document and extracts its sections based on headings and structural markers.

The parsed document appears in the file list immediately. Click on it to open the section tree and begin working with individual sections.

Section Management

After a document is uploaded and parsed, AIRGen splits it into a hierarchy of sections based on the document's heading structure. Each section becomes a first-class entity in your project graph.

To work with sections:

1. Click on a document in the file list to open it.
2. The Section Tree panel displays the document's structure as a collapsible tree. Top-level headings appear at the root, with nested subheadings beneath them.
3. Click any section in the tree to view its content in the reading pane.
4. Click Edit to modify the section content using the built-in Markdown editor.

Each section has its own metadata, including a unique identifier, title, and level in the document hierarchy. Sections can be individually linked to requirements, architecture blocks, and other entities through AIRGen's traceability system.

Linking Sections to Requirements

One of the most valuable capabilities in AIRGen is connecting document sections directly to requirements. These trace links provide compliance evidence that every requirement has a documented source and every document section has been addressed by the engineering process.

To link a section to a requirement:

1. Open a document and select a section in the section tree.
2. In the section detail panel, click Link to Requirement.
3. Search for the target requirement by title or ID. You can also browse the full requirements list.
4. Select the link type. Common types include derives-from (the requirement was derived from this section) and satisfies (the section provides evidence that the requirement is addressed).
5. Click Create Link to save the trace relationship.

Once created, the link is visible from both the section detail panel and the requirement detail panel. Navigate in either direction by clicking the linked entity.

Folder Organization

As your project grows, organizing documents into folders keeps the file list manageable and reflects your project's structure.

To create and manage folders:

1. On the Documents page, click New Folder in the toolbar.
2. Enter a folder name. Common naming conventions include organizing by project phase (e.g., "Concept", "Design", "Verification"), by discipline (e.g., "Systems", "Software", "Hardware"), or by document type (e.g., "Specifications", "Standards", "Meeting Notes").
3. Click Create. The folder appears in the file list.
4. Drag and drop documents into folders to reorganize them. You can also drag documents between folders or back to the root level.

Folders can be nested to any depth. The folder structure is reflected in the file manager's grid and list views. You can switch between views using the toggle in the toolbar.

Markdown Editor

AIRGen includes a built-in Markdown editor for working with section content. The editor supports full Markdown syntax with a live preview pane so you can see the rendered output as you type.

Supported Markdown features include:

• Headings — Use # through ###### for heading levels 1 through 6.
• Bold and italic — Use **bold** and *italic* for emphasis.
• Lists — Ordered (1.) and unordered (-) lists, with nesting support.
• Tables — Standard Markdown table syntax with alignment support.
• Code blocks — Inline code with backticks and fenced code blocks with triple backticks.
• Links and images — Standard Markdown link and image syntax.

Entity References

The editor supports a special reference syntax for linking to other entities in your project graph. Type @ followed by the entity type and ID to insert a clickable reference:

• @REQ-001 — References a requirement.
• @ARCH-012 — References an architecture block.
• @DOC-005/S3 — References a specific section within a document.

These references are resolved at render time and display as clickable links that navigate directly to the referenced entity. They also create implicit trace relationships in the project graph.