Skip to content

Guideline Documents

Guideline documents are essential resources that inform the architect agent's analysis and recommendations. They help ensure consistency, compliance, and best practices across your organization's software architecture decisions.

Overview

The Guideline Documents feature allows you to maintain a centralized repository of architectural guidelines, standards, and policies that the architect agent uses when analyzing your systems. You can view shared documents provided by the system and upload custom documents tailored to your organization's specific requirements.

Key Features

  • shared Guidelines: Access system-provided architectural guidelines that the architect agent uses by default
  • Custom Document Upload: Upload your organization's specific architectural guidelines and standards
  • Document Management: Edit or delete your uploaded documents to keep your guidelines current
  • Architect Agent Integration: Your guideline documents are automatically considered during architect agent analysis
  • Read-Only shared documents: System-provided shared documents cannot be modified or deleted to maintain consistency

Working with Guideline Documents

Viewing Guideline Documents

When you navigate to the Guideline Documents section, you'll see:

  1. shared Documents - System-provided architectural guidelines (read-only)
  2. Custom Documents - Documents you've uploaded for your organization

Uploading Custom Documents

To upload a guideline document for your architect agent to use:

  1. Navigate to the Guideline Documents section
  2. Click the Add Document button
  3. Provide the document name
  4. Select your document file from your system
  5. Optionally add a description to help identify the document's purpose
  6. Click Create to save the document

Supported formats: PDF, Word documents, and text files

Best practices for document uploads: - Use clear, descriptive names for your documents - Include a brief description of the document's purpose - Ensure documents contain relevant architectural guidelines and standards - Keep documents organized by category or domain

Editing Custom Documents

You can modify custom documents you've uploaded to keep them current with your organization's evolving standards:

  1. Locate your custom document in the list
  2. Click the Edit button (pencil icon)
  3. Update the document metadata such as:
  4. Document name
  5. Description
  6. Or re-upload a new version of the document
  7. Click Update to apply changes

Note: You cannot edit system-provided shared documents. These are maintained by the system to ensure baseline consistency.

Deleting Custom Documents

If a custom document is no longer needed:

  1. Locate the custom document in the list
  2. Click the Delete button (trash icon)
  3. Confirm the deletion when prompted
  4. The document will be removed and no longer used by the architect agent

Important: - Only custom documents you uploaded can be deleted - shared system documents cannot be deleted - Deleted documents cannot be recovered, so ensure you have backups if needed

How Architect Agent Uses Guideline Documents

The architect agent considers all available guideline documents (both shared and custom) when:

  • Analyzing your current architecture
  • Providing recommendations for improvements
  • Suggesting compliance and best practice alignments
  • Evaluating design patterns and standards adherence

By maintaining comprehensive and up-to-date guideline documents, you ensure that the architect agent's recommendations align with your organization's standards and requirements.