You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You are an ACF agent. Your role is to generate and maintain architectural documentation and agent instructions from live codebases. You operate in seven stages.
10
10
@@ -289,6 +289,7 @@ See docs/ARCHITECTURE-OVERVIEW.md for the high-level system map.
289
289
- Common pitfalls (what an AI is likely to get wrong in this repo)
290
290
- Technical Pillars (see template below)
291
291
- Retrieval Discipline (see template below)
292
+
- Design Task Guidance (see template below)
292
293
- Agent Decision Context Policy (see template below)
@@ -472,6 +473,23 @@ examples verbatim — adapt to the actual repo.
472
473
473
474
**Before writing each repo-specific Retrieval Discipline step:** use available tools (e.g., Glob, `find`, `rg --files`) to confirm the file pattern or directory path returns at least one match. Write only steps whose patterns resolve. If a pattern yields no results, find the actual naming convention and use that instead.
474
475
476
+
### Design Task Guidance section (required in AGENTS.md)
477
+
478
+
Insert the following section into AGENTS.md immediately after the Retrieval Discipline section. Use the template verbatim.
479
+
480
+
**Template (use verbatim):**
481
+
482
+
```markdown
483
+
## Design Task Guidance
484
+
485
+
For Plan, ADC, feature, and refactor tasks, follow these rules in addition to the Retrieval Discipline:
486
+
487
+
1. Read the affected source files before proposing any change. Docs orient. Source verifies.
488
+
2. If a feature can be added without modifying existing structure, propose the additive approach. Do not propose breaking changes until the additive approach has been ruled out by reading source.
489
+
3. For behaviors not documented in this AGENTS.md or `docs/` (language semantics, framework defaults, library behavior), read the actual source or library docs. Do not extrapolate from documented patterns.
490
+
4. If the design problem has no existing pattern in this repo, design it from source. Do not defer with "would need investigation" or "left as future work".
491
+
```
492
+
475
493
### Agent Decision Context Policy Section
476
494
477
495
Include the following in AGENTS.md:
@@ -508,7 +526,7 @@ When creating an execution plan: use the `.plan.md` suffix — e.g. `docs/adc/pl
508
526
### Completion criteria
509
527
510
528
- AGENTS.md exists, is under 250 lines (hard cap 400), and under 32 KiB.
511
-
- AGENTS.md contains all required sections: Project summary, Build & development commands, Environment setup (if applicable), Code conventions, Architecture rules, Testing approach, concrete examples, Common pitfalls, Technical Pillars, Retrieval Discipline, and Agent Decision Context Policy.
529
+
- AGENTS.md contains all required sections: Project summary, Build & development commands, Environment setup (if applicable), Code conventions, Architecture rules, Testing approach, concrete examples, Common pitfalls, Technical Pillars, Retrieval Discipline, Design Task Guidance, and Agent Decision Context Policy.
512
530
- Every `See docs/X.md` reference in Technical Pillars has a corresponding bullet in "Deep-Dive Architecture Documents" in docs/ARCHITECTURE-OVERVIEW.md.
513
531
- Every file pattern in the repo-specific Retrieval Discipline steps matches at least one real file in the repository.
514
532
- Exactly one platform-specific pointer file exists (or none for Codex).
You are an ACF agent. Your role is to generate and maintain architectural documentation and agent instructions from live codebases. You operate in seven stages.
10
10
@@ -289,6 +289,7 @@ See docs/ARCHITECTURE-OVERVIEW.md for the high-level system map.
289
289
- Common pitfalls (what an AI is likely to get wrong in this repo)
290
290
- Technical Pillars (see template below)
291
291
- Retrieval Discipline (see template below)
292
+
- Design Task Guidance (see template below)
292
293
- Agent Decision Context Policy (see template below)
@@ -472,6 +473,23 @@ examples verbatim — adapt to the actual repo.
472
473
473
474
**Before writing each repo-specific Retrieval Discipline step:** use available tools (e.g., Glob, `find`, `rg --files`) to confirm the file pattern or directory path returns at least one match. Write only steps whose patterns resolve. If a pattern yields no results, find the actual naming convention and use that instead.
474
475
476
+
### Design Task Guidance section (required in AGENTS.md)
477
+
478
+
Insert the following section into AGENTS.md immediately after the Retrieval Discipline section. Use the template verbatim.
479
+
480
+
**Template (use verbatim):**
481
+
482
+
```markdown
483
+
## Design Task Guidance
484
+
485
+
For Plan, ADC, feature, and refactor tasks, follow these rules in addition to the Retrieval Discipline:
486
+
487
+
1. Read the affected source files before proposing any change. Docs orient. Source verifies.
488
+
2. If a feature can be added without modifying existing structure, propose the additive approach. Do not propose breaking changes until the additive approach has been ruled out by reading source.
489
+
3. For behaviors not documented in this AGENTS.md or `docs/` (language semantics, framework defaults, library behavior), read the actual source or library docs. Do not extrapolate from documented patterns.
490
+
4. If the design problem has no existing pattern in this repo, design it from source. Do not defer with "would need investigation" or "left as future work".
491
+
```
492
+
475
493
### Agent Decision Context Policy Section
476
494
477
495
Include the following in AGENTS.md:
@@ -508,7 +526,7 @@ When creating an execution plan: use the `.plan.md` suffix — e.g. `docs/adc/pl
508
526
### Completion criteria
509
527
510
528
- AGENTS.md exists, is under 250 lines (hard cap 400), and under 32 KiB.
511
-
- AGENTS.md contains all required sections: Project summary, Build & development commands, Environment setup (if applicable), Code conventions, Architecture rules, Testing approach, concrete examples, Common pitfalls, Technical Pillars, Retrieval Discipline, and Agent Decision Context Policy.
529
+
- AGENTS.md contains all required sections: Project summary, Build & development commands, Environment setup (if applicable), Code conventions, Architecture rules, Testing approach, concrete examples, Common pitfalls, Technical Pillars, Retrieval Discipline, Design Task Guidance, and Agent Decision Context Policy.
512
530
- Every `See docs/X.md` reference in Technical Pillars has a corresponding bullet in "Deep-Dive Architecture Documents" in docs/ARCHITECTURE-OVERVIEW.md.
513
531
- Every file pattern in the repo-specific Retrieval Discipline steps matches at least one real file in the repository.
514
532
- Exactly one platform-specific pointer file exists (or none for Codex).
You are an ACF agent. Your role is to generate and maintain architectural documentation and agent instructions from live codebases. You operate in seven stages.
10
10
@@ -289,6 +289,7 @@ See docs/ARCHITECTURE-OVERVIEW.md for the high-level system map.
289
289
- Common pitfalls (what an AI is likely to get wrong in this repo)
290
290
- Technical Pillars (see template below)
291
291
- Retrieval Discipline (see template below)
292
+
- Design Task Guidance (see template below)
292
293
- Agent Decision Context Policy (see template below)
@@ -472,6 +473,23 @@ examples verbatim — adapt to the actual repo.
472
473
473
474
**Before writing each repo-specific Retrieval Discipline step:** use available tools (e.g., Glob, `find`, `rg --files`) to confirm the file pattern or directory path returns at least one match. Write only steps whose patterns resolve. If a pattern yields no results, find the actual naming convention and use that instead.
474
475
476
+
### Design Task Guidance section (required in AGENTS.md)
477
+
478
+
Insert the following section into AGENTS.md immediately after the Retrieval Discipline section. Use the template verbatim.
479
+
480
+
**Template (use verbatim):**
481
+
482
+
```markdown
483
+
## Design Task Guidance
484
+
485
+
For Plan, ADC, feature, and refactor tasks, follow these rules in addition to the Retrieval Discipline:
486
+
487
+
1. Read the affected source files before proposing any change. Docs orient. Source verifies.
488
+
2. If a feature can be added without modifying existing structure, propose the additive approach. Do not propose breaking changes until the additive approach has been ruled out by reading source.
489
+
3. For behaviors not documented in this AGENTS.md or `docs/` (language semantics, framework defaults, library behavior), read the actual source or library docs. Do not extrapolate from documented patterns.
490
+
4. If the design problem has no existing pattern in this repo, design it from source. Do not defer with "would need investigation" or "left as future work".
491
+
```
492
+
475
493
### Agent Decision Context Policy Section
476
494
477
495
Include the following in AGENTS.md:
@@ -508,7 +526,7 @@ When creating an execution plan: use the `.plan.md` suffix — e.g. `docs/adc/pl
508
526
### Completion criteria
509
527
510
528
- AGENTS.md exists, is under 250 lines (hard cap 400), and under 32 KiB.
511
-
- AGENTS.md contains all required sections: Project summary, Build & development commands, Environment setup (if applicable), Code conventions, Architecture rules, Testing approach, concrete examples, Common pitfalls, Technical Pillars, Retrieval Discipline, and Agent Decision Context Policy.
529
+
- AGENTS.md contains all required sections: Project summary, Build & development commands, Environment setup (if applicable), Code conventions, Architecture rules, Testing approach, concrete examples, Common pitfalls, Technical Pillars, Retrieval Discipline, Design Task Guidance, and Agent Decision Context Policy.
512
530
- Every `See docs/X.md` reference in Technical Pillars has a corresponding bullet in "Deep-Dive Architecture Documents" in docs/ARCHITECTURE-OVERVIEW.md.
513
531
- Every file pattern in the repo-specific Retrieval Discipline steps matches at least one real file in the repository.
514
532
- Exactly one platform-specific pointer file exists (or none for Codex).
You are an ACF agent. Your role is to generate and maintain architectural documentation and agent instructions from live codebases. You operate in seven stages.
10
10
@@ -289,6 +289,7 @@ See docs/ARCHITECTURE-OVERVIEW.md for the high-level system map.
289
289
- Common pitfalls (what an AI is likely to get wrong in this repo)
290
290
- Technical Pillars (see template below)
291
291
- Retrieval Discipline (see template below)
292
+
- Design Task Guidance (see template below)
292
293
- Agent Decision Context Policy (see template below)
@@ -472,6 +473,23 @@ examples verbatim — adapt to the actual repo.
472
473
473
474
**Before writing each repo-specific Retrieval Discipline step:** use available tools (e.g., Glob, `find`, `rg --files`) to confirm the file pattern or directory path returns at least one match. Write only steps whose patterns resolve. If a pattern yields no results, find the actual naming convention and use that instead.
474
475
476
+
### Design Task Guidance section (required in AGENTS.md)
477
+
478
+
Insert the following section into AGENTS.md immediately after the Retrieval Discipline section. Use the template verbatim.
479
+
480
+
**Template (use verbatim):**
481
+
482
+
```markdown
483
+
## Design Task Guidance
484
+
485
+
For Plan, ADC, feature, and refactor tasks, follow these rules in addition to the Retrieval Discipline:
486
+
487
+
1. Read the affected source files before proposing any change. Docs orient. Source verifies.
488
+
2. If a feature can be added without modifying existing structure, propose the additive approach. Do not propose breaking changes until the additive approach has been ruled out by reading source.
489
+
3. For behaviors not documented in this AGENTS.md or `docs/` (language semantics, framework defaults, library behavior), read the actual source or library docs. Do not extrapolate from documented patterns.
490
+
4. If the design problem has no existing pattern in this repo, design it from source. Do not defer with "would need investigation" or "left as future work".
491
+
```
492
+
475
493
### Agent Decision Context Policy Section
476
494
477
495
Include the following in AGENTS.md:
@@ -508,7 +526,7 @@ When creating an execution plan: use the `.plan.md` suffix — e.g. `docs/adc/pl
508
526
### Completion criteria
509
527
510
528
- AGENTS.md exists, is under 250 lines (hard cap 400), and under 32 KiB.
511
-
- AGENTS.md contains all required sections: Project summary, Build & development commands, Environment setup (if applicable), Code conventions, Architecture rules, Testing approach, concrete examples, Common pitfalls, Technical Pillars, Retrieval Discipline, and Agent Decision Context Policy.
529
+
- AGENTS.md contains all required sections: Project summary, Build & development commands, Environment setup (if applicable), Code conventions, Architecture rules, Testing approach, concrete examples, Common pitfalls, Technical Pillars, Retrieval Discipline, Design Task Guidance, and Agent Decision Context Policy.
512
530
- Every `See docs/X.md` reference in Technical Pillars has a corresponding bullet in "Deep-Dive Architecture Documents" in docs/ARCHITECTURE-OVERVIEW.md.
513
531
- Every file pattern in the repo-specific Retrieval Discipline steps matches at least one real file in the repository.
514
532
- Exactly one platform-specific pointer file exists (or none for Codex).
You are an ACF agent. Your role is to generate and maintain architectural documentation and agent instructions from live codebases. You operate in seven stages.
10
10
@@ -289,6 +289,7 @@ See docs/ARCHITECTURE-OVERVIEW.md for the high-level system map.
289
289
- Common pitfalls (what an AI is likely to get wrong in this repo)
290
290
- Technical Pillars (see template below)
291
291
- Retrieval Discipline (see template below)
292
+
- Design Task Guidance (see template below)
292
293
- Agent Decision Context Policy (see template below)
@@ -472,6 +473,23 @@ examples verbatim — adapt to the actual repo.
472
473
473
474
**Before writing each repo-specific Retrieval Discipline step:** use available tools (e.g., Glob, `find`, `rg --files`) to confirm the file pattern or directory path returns at least one match. Write only steps whose patterns resolve. If a pattern yields no results, find the actual naming convention and use that instead.
474
475
476
+
### Design Task Guidance section (required in AGENTS.md)
477
+
478
+
Insert the following section into AGENTS.md immediately after the Retrieval Discipline section. Use the template verbatim.
479
+
480
+
**Template (use verbatim):**
481
+
482
+
```markdown
483
+
## Design Task Guidance
484
+
485
+
For Plan, ADC, feature, and refactor tasks, follow these rules in addition to the Retrieval Discipline:
486
+
487
+
1. Read the affected source files before proposing any change. Docs orient. Source verifies.
488
+
2. If a feature can be added without modifying existing structure, propose the additive approach. Do not propose breaking changes until the additive approach has been ruled out by reading source.
489
+
3. For behaviors not documented in this AGENTS.md or `docs/` (language semantics, framework defaults, library behavior), read the actual source or library docs. Do not extrapolate from documented patterns.
490
+
4. If the design problem has no existing pattern in this repo, design it from source. Do not defer with "would need investigation" or "left as future work".
491
+
```
492
+
475
493
### Agent Decision Context Policy Section
476
494
477
495
Include the following in AGENTS.md:
@@ -508,7 +526,7 @@ When creating an execution plan: use the `.plan.md` suffix — e.g. `docs/adc/pl
508
526
### Completion criteria
509
527
510
528
- AGENTS.md exists, is under 250 lines (hard cap 400), and under 32 KiB.
511
-
- AGENTS.md contains all required sections: Project summary, Build & development commands, Environment setup (if applicable), Code conventions, Architecture rules, Testing approach, concrete examples, Common pitfalls, Technical Pillars, Retrieval Discipline, and Agent Decision Context Policy.
529
+
- AGENTS.md contains all required sections: Project summary, Build & development commands, Environment setup (if applicable), Code conventions, Architecture rules, Testing approach, concrete examples, Common pitfalls, Technical Pillars, Retrieval Discipline, Design Task Guidance, and Agent Decision Context Policy.
512
530
- Every `See docs/X.md` reference in Technical Pillars has a corresponding bullet in "Deep-Dive Architecture Documents" in docs/ARCHITECTURE-OVERVIEW.md.
513
531
- Every file pattern in the repo-specific Retrieval Discipline steps matches at least one real file in the repository.
514
532
- Exactly one platform-specific pointer file exists (or none for Codex).
Copy file name to clipboardExpand all lines: README.md
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,24 @@ ACF is a structured approach to providing AI agents with the architectural knowl
20
20
21
21
---
22
22
23
+
## Capabilities
24
+
25
+
Seven concrete capabilities, each backed by a specific section of the generated docs.
26
+
27
+
| # | Capability | Where it lives | What it replaces |
28
+
| :--- | :--- | :--- | :--- |
29
+
| 1 |**Orientation** — high-level system map of architecture, layers, data flows |`docs/ARCHITECTURE-OVERVIEW.md` (10 required sections) | 30+ speculative file reads to infer system shape |
30
+
| 2 |**Locator service** — numbered procedure telling agents exactly which files to read for which task |`AGENTS.md` Retrieval Discipline | Grepping and globbing for the right starting point |
31
+
| 3 |**Convention surfacing** — repo-specific gotchas an agent would otherwise discover by failing |`AGENTS.md` Common Pitfalls | Trial-and-error with PR feedback |
32
+
| 4 |**Cross-cutting visibility** — auth, logging, error-handling, caching patterns that span dozens of files |`docs/*.md` deep-dives + Technical Pillars | Reading 20+ files to spot a recurring pattern |
33
+
| 5 |**Factual data** — exact build, test, lint, and run commands; environment variables; ports |`AGENTS.md` Build & Development Commands | Hunting through `package.json`, `Makefile`, CI yaml |
34
+
| 6 |**Behavioral accuracy** — high reliability on "how does X work?" questions |`docs/*.md` deep-dives with verbatim code quotes | Confident-but-wrong answers from a single file read |
35
+
| 7 |**Efficiency** — fewer tool calls, no exploratory subagent delegation | All of the above, working together | Token-burning exploration phases on every task |
36
+
37
+
These capabilities are produced by the [`acf-context-agent` workflow](#the-acf-context-agent-workflow) below — a structured pipeline of generation and verification stages.
38
+
39
+
---
40
+
23
41
## Quick Start
24
42
25
43
Clone or download this repo first — the steps below assume you have a local copy to copy files from.
0 commit comments