Creating Documents

Learn how to create new technical documents in ArchDoc.

Quick Start

1. Navigate to Dashboard > Documents
2. Click the New Document button
3. Fill in the document details
4. Click Create

Document Creation Form

Document Title

Enter a clear, descriptive title for your document.

Good examples:

• "Use PostgreSQL as Primary Database"
• "RFC: Implement User Notifications"
• "Design Doc: Payment System Architecture"

Avoid:

• "Untitled"
• "New ADR"
• "Document 1"

Document Type

Select the appropriate type:

See Document Types for guidance on choosing.

Initial Content (Built-in Templates)

When you select a document type, the editor is pre-populated with a starter template tailored to that type:

You can edit or clear the template before saving.

After Creating

Once created, you'll be taken to the document editor where you can:

1. Write content using the rich text editor
2. Add diagrams with Excalidraw or Mermaid
3. Format text with headings, lists, code blocks
4. Save changes manually or auto-save

Document Slug

Each document gets a unique slug based on its title:

• Title: "Use PostgreSQL Database"
• Slug: use-postgresql-database

The slug is used in the document URL:

/dashboard/documents/use-postgresql-database

Document Categories

New documents start as In Progress. You can change the category as the document evolves:

Best Practices

Start with a Clear Title

• The title should explain what the document is about
• Include the document type if helpful (e.g., "RFC: ...")

Choose the Right Type

• Don't use Design Doc for a simple decision (use ADR)
• Don't use ADR for a proposal needing discussion (use RFC)

Draft First, Format Later

• Get your ideas down first
• Polish formatting afterward

Save Regularly

• Auto-save helps, but manual saves ensure nothing is lost
• The editor caches content locally as backup

Document Limits

Your plan determines how many documents you can create:

If you reach your limit:

• Archive or delete old documents
• Upgrade your plan

Permissions

Who can create documents:

All authenticated users in your organization can create documents.

Next Steps

After creating a document:

• Edit your document
• Add diagrams
• Request sign-offs