|
1 | | -# 🚀 ai-ready-docs: The Standard for AI-Native Documentation |
| 1 | +# 📖 AIRD (AI-Ready Documentation) - Site Map |
2 | 2 |
|
3 | | -[](https://github.com/iwweee/ai-ready-docs) |
4 | | -[](https://spdx.org/licenses/mit.html) |
| 3 | +Welcome to the official documentation for the **AI-Ready Documentation (AIRD) Standard**. This project provides the specifications, tools, and templates needed to make your documentation "AI-native." |
5 | 4 |
|
6 | | -**Stop writing documentation for humans. Start building APIs for LLMs.** |
| 5 | +## 🗺️ Quick Navigation |
7 | 6 |
|
8 | | -`ai-ready-docs` (AIRD) is a rigorous specification designed to transform documentation from "human-readable text" into "**AI-consumable interfaces**." |
| 7 | +### 📜 Core Specification |
| 8 | +- **[AIRD SPEC v1.2](./AIRD_SPEC.md)**: The definitive guide to the 5 layers of AI-ready docs (L1-L5). |
| 9 | +- **[L5 Agentic Guide](./L5_AGENTIC_GUIDE.md)**: Specialized guide for implementing the Actionable Layer and Evolutionary Loops. |
| 10 | +- **[Feedback Workflow](./FEEDBACK_WORKFLOW.md)**: How to operationalize the L4 evolution loop. |
9 | 11 |
|
10 | | -In the era of Agentic Workflows and RAG, the bottleneck is no longer the model's reasoning power, but the **quality and structure of the context** provided. AIRD eliminates ambiguity, minimizes token waste, and virtually erases LLM hallucinations. |
| 12 | +### 🛠️ Tools & Automation |
| 13 | +- **[AIRD Linter (v5)](./aird_lint_v5.py)**: The official tool to measure and validate your documentation's AI-readiness. |
11 | 14 |
|
12 | | ---- |
13 | | - |
14 | | -## 📊 The AIRD Advantage |
| 15 | +### 📚 Templates & Examples |
| 16 | +- **[Examples Gallery](./examples/)**: |
| 17 | + - [Python Library Template](./examples/python-lib/) |
| 18 | + - [System Architecture Template](./examples/system-arch/) |
| 19 | + - [Agent SOP Template](./examples/agent-sop/) |
15 | 20 |
|
16 | | -| Dimension | Traditional Docs (Human-Centric) | AIRD Standard (AI-Native) | |
17 | | -| :--- | :--- | :--- | |
18 | | -| **Discovery** | Manual search / Random crawling | $\text{L1 Discovery} \rightarrow$ Instant mapping via `llms.txt` | |
19 | | -| **Parsing** | Heuristic chunking (Unpredictable) | $\text{L2 Structure} \rightarrow$ Deterministic hierarchy | |
20 | | -| **Cognition** | Reliance on LLM's general knowledge | $\text{L3 Context} \rightarrow$ Explicit `ai-context` blocks | |
21 | | -| **Maintenance** | Manual updates $\rightarrow$ Doc drift | $\text{L4 Evolution} \rightarrow$ Closed-loop `.ai-feedback` | |
| 21 | +### 🧪 AI Model Benchmarks |
| 22 | +A collection of documentation tailored for the strengths and weaknesses of specific LLMs: |
| 23 | +- **[GPT-5.5](./gpt-5-5-zh.md)** |
| 24 | +- **[Claude Opus 4.8](./claude-opus-4-8.md)** |
| 25 | +- **[Gemini Omni Flash](./gemini-omni-flash-zh.md)** |
| 26 | +- *(See more in the root directory)* |
22 | 27 |
|
23 | 28 | --- |
24 | 29 |
|
25 | | -## 🏗️ The 4-Layer Protocol (AIRD Spec v1.1) |
26 | | - |
27 | | -### 📡 L1: Discovery (The Map) |
28 | | -**Goal**: Immediate orientation via `llms.txt`. |
29 | | - |
30 | | -### 🏗️ L2: Structure (The Skeleton) |
31 | | -**Goal**: Perfect chunking via strict hierarchy and deterministic naming. |
32 | | - |
33 | | -### 🧠 L3: Context (The Brain) |
34 | | -**Goal**: Eliminate assumptions using `ai-context` blocks (Topic, Prerequisites, Warnings). |
| 30 | +## 🎯 Which path should you take? |
35 | 31 |
|
36 | | -### 🔄 L4: Evolution (The Loop) |
37 | | -**Goal**: Continuous self-improvement via the `.ai-feedback.md` mechanism. |
| 32 | +| If you are... | Start here $\rightarrow$ | |
| 33 | +| :--- | :--- | |
| 34 | +| **New to AIRD** | [README.md](./README.md) $\rightarrow$ [AIRD_SPEC.md](./AIRD_SPEC.md) | |
| 35 | +| **Updating an existing project** | [L5 Agentic Guide](./L5_AGENTIC_GUIDE.md) | |
| 36 | +| **Building an AI Agent** | [L5 Agentic Guide](./L5_AGENTIC_GUIDE.md) $\rightarrow$ [Feedback Workflow](./FEEDBACK_WORKFLOW.md) | |
| 37 | +| **Auditing your docs** | [Run aird_lint_v5.py](./aird_lint_v5.py) | |
38 | 38 |
|
39 | 39 | --- |
40 | | - |
41 | | -## 🛠️ Getting Started (The Fast Track) |
42 | | - |
43 | | -### 1. 📚 Learn by Example |
44 | | -Don't start from scratch. Copy our proven AIRD templates for different scenarios: |
45 | | -👉 **[Explore the Examples Gallery](./examples/)** |
46 | | -- **Python Lib**: Ideal for SDKs and utility tools. |
47 | | -- **System Architecture**: Best for complex enterprise software. |
48 | | -- **Agent SOP**: Perfect for AI-driven workflows. |
49 | | - |
50 | | -### 2. 📈 Measure Your "AI-Readiness" |
51 | | -Run our advanced Linter to get a quantitative **AI-Ready Score (0-100)** and a detailed compliance report. |
52 | | -```bash |
53 | | -# Install/Download aird_lint_v5.py |
54 | | -python aird_lint_v5.py --suggest ./your-docs-folder |
55 | | -``` |
56 | | -*The linter now checks for broken semantic dependencies and calculates your readiness rank (Elite $\rightarrow$ Low).* |
57 | | - |
58 | | -### 3. 🔄 Operationalize the Feedback Loop |
59 | | -Stop manually fixing docs. Implement the L4 evolutionary workflow to let AI failures drive your documentation updates. |
60 | | -👉 **[Read the Feedback Workflow Guide](./FEEDBACK_WORKFLOW.md)** |
61 | | - |
62 | | -### 4. 📜 Detailed Specification |
63 | | -For a deep dive into the technical requirements of each layer: |
64 | | -👉 **[Read the Full SPEC.md](./SPEC.md)** |
65 | | - |
66 | | ---- |
67 | | - |
68 | | -## 🌟 Adoption & Ecosystem |
69 | | - |
70 | | -We are building a world where every project is `AI-Ready`. |
71 | | - |
72 | | -- **Current Status**: v1.1 (Evolutionary Stage) |
73 | | -- **Goal**: To become the default documentation layer for autonomous AI agents. |
74 | | - |
75 | | -If you've implemented AIRD in your project, please let us know or open a PR to be added to our **AIRD-Compliant Projects** list! |
76 | | - |
77 | | ---- |
78 | | - |
79 | | -## 📄 License |
80 | | -Distributed under the MIT License. See `LICENSE` for more information. |
| 40 | +*AIRD v1.2: From Information Retrieval to Autonomous Execution.* |
0 commit comments