Getting Started
Learn the basics of AutEng and create your first document
Quick Start
Sign Up
Create your free account using GitHub, Google, or email. Get started in seconds.
Create a Document
Click "New Document" and start writing. Use Markdown, Mermaid diagrams, or KaTeX math.
# My First Architecture Doc
## System Overview
This is a microservices architecture...
```mermaid
graph LR
A[Client] --> B[API Gateway]
B --> C[Service 1]
B --> D[Service 2]
```Use AI to Generate
Let AI help you create diagrams, expand sections, or draft entire documents.
"Generate a sequence diagram for user authentication"
Share with Your Team
Generate a public share link or export to PDF. Your docs are always beautifully formatted.
Key Features
GitHub Flavored Markdown
Write docs the way developers think. Full GFM support including tables, task lists, and code blocks.
Mermaid Diagrams
Create flowcharts, sequence diagrams, class diagrams, and more. No external tools needed.
KaTeX Math
Write mathematical equations with LaTeX syntax. Perfect for algorithms and data science docs.
AI-Powered Generation
Describe what you need and let AI create diagrams, expand sections, or draft entire documents.
Version History
Track changes over time with visual diffs. Never lose work or wonder what changed.
Public Sharing
Generate beautiful public share links. Perfect for sharing with stakeholders or the community.
Common Use Cases
Architecture Documentation →
System designs, component diagrams, data flows, and technical specifications
API Documentation →
REST APIs, GraphQL schemas, authentication flows, and endpoint specifications
Technical Specifications →
ADRs, RFCs, design docs, and implementation plans
Team Collaboration →
Runbooks, onboarding guides, and team knowledge bases
Tips for Success
- •Start with structure: Use headings to organize your document before filling in details
- •Let AI help: Describe what you want instead of writing complex diagrams manually
- •Use visual elements: Diagrams and tables make technical concepts easier to understand
- •Share early: Get feedback while you're writing, not after you're done
- •Keep it updated: Use version history to track changes and maintain accuracy
Related Content
Features
Explore all the powerful features AutEng offers for technical documentation
Markdown, Mermaid & KaTeX Syntax
Complete syntax reference for Markdown, Mermaid diagrams, and KaTeX math equations
Using KaTeX in AutEng
Practical guide to integrating mathematical equations in your documentation
Architecture Documentation
Document system architecture and design with diagrams and flows
Documentation Best Practices — Markdown + Mermaid + KaTeX
Comprehensive guide to creating exceptional technical documentation using Markdown, Mermaid diagrams, and KaTeX equations together
Next: Markdown, Mermaid & KaTeX Syntax
Complete syntax reference for Markdown, Mermaid diagrams, and KaTeX math equations
Continue Reading