Engineering Practices
ReferenceImplemented
Documentation Standards
Diátaxis framework conventions, frontmatter schemas, and authoring templates.
Documentation Standards
Attendrix engineering documentation adheres strictly to the Diátaxis documentation framework.
Every document must be explicitly classified into one of the four categories:
- Tutorial (Learning-oriented)
- How-to Guide (Goal-oriented)
- Explanation (Understanding-oriented)
- Reference (Information-oriented)
Required Frontmatter Schema
---
title: Course Enrollment Architecture
description: How Attendrix models courses, offerings, and user enrollments.
type: explanation # tutorial | how-to | explanation | reference
status: implemented # planned | draft | in-progress | implemented | deprecated | experimental | archived
category: backend # optional
order: 1 # optional
lastUpdated: 2026-09-04 # optional
---Authoring Templates
1. Explanation Template
Use when explaining architecture, background context, or design decisions.
---
title: ...
description: ...
type: explanation
status: implemented
---
## Overview
High-level summary of the subsystem or architectural domain.
## Architecture & Diagram
<ArchitectureDiagram level="container" title="...">
<Mermaid chart="..." />
</ArchitectureDiagram>
## How It Works
Detailed narrative of components, lifecycle, and data flow.
## Important Invariants
<Invariant id="INV-01" scope="Database">
...
</Invariant>
## Related Documentation
<RelatedPages pages={[...]} />2. How-to Template
Use when guiding an engineer through a concrete task.
---
title: ...
description: ...
type: how-to
status: implemented
---
## Before You Start
Prerequisites, tools, and required permissions.
## Step 1: ...
## Step 2: ...
## Step 3: ...
## Verification
Commands or tests to prove the task succeeded.
## Troubleshooting
Common pitfalls and their solutions.3. Reference Template
Use when describing schemas, RPC signatures, tables, or APIs.
---
title: ...
description: ...
type: reference
status: implemented
---
## Purpose
What this interface or table represents.
## Schema / Properties
<PropertyTable properties={[...]} />
## Constraints & Security
RLS policies, triggers, and foreign keys.
## Examples
```sql
SELECT * FROM ...;Was this page helpful?
Your feedback directly guides the engineering documentation roadmap.