docs

name	docs
description	Documentation guidelines for this project. Use when writing or updating markdown documentation, README files, or specifications. Enforces English language, table alignment, and ASCII diagram formatting.
metadata	{"author":"Alexandre Roman","version":"1.0"}

Documentation

Guidelines for writing documentation in this project.

Language Rules

IMPORTANT: Always write documentation in English.

• All documentation files must be in English
• Code comments should be concise and explain "why" not "what"
• Use clear, technical language

Formatting Rules

Tables

Tables must be properly aligned with consistent column widths:

| Column A   | Column B      | Column C        |
|------------|---------------|-----------------|
| Value 1    | Description   | Additional info |
| Value 2    | Description   | Additional info |

Diagrams

ASCII diagrams must be well-aligned and properly formatted:

┌─────────────┐     ┌─────────────┐
│  Component  │────>│  Component  │
└─────────────┘     └─────────────┘

Use box-drawing characters:

• Corners: ┌ ┐ └ ┘
• Lines: ─ │
• Arrows: > v < ^
• Connections: ┬ ┴ ├ ┤ ┼

Code Blocks

Always specify the language for syntax highlighting:

interface Example {
  id: string;
}

File Locations

Type	Location
Specifications	specs/
Project guidelines	CLAUDE.md
README	README.md