Skip to content

Commit f29d082

Browse files
author
Ichbinsoftware
committed
Release 1.0.0
1 parent b9d8668 commit f29d082

17 files changed

Lines changed: 3765 additions & 1 deletion

.claude/agents/acf-context-agent.md

Lines changed: 476 additions & 0 deletions
Large diffs are not rendered by default.

.codex/agents/acf-context-agent.md

Lines changed: 476 additions & 0 deletions
Large diffs are not rendered by default.

.cursor/agents/acf-context-agent.md

Lines changed: 476 additions & 0 deletions
Large diffs are not rendered by default.

.gemini/agents/acf-context-agent.md

Lines changed: 476 additions & 0 deletions
Large diffs are not rendered by default.

.github/agents/acf-context-agent.md

Lines changed: 476 additions & 0 deletions
Large diffs are not rendered by default.

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# OS generated files
2+
.DS_Store
3+
.DS_Store?
4+
._*
5+
.Spotlight-V100
6+
.Trashes
7+
ehthumbs.db
8+
Thumbs.db

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Andrew Rickard (ichbinsoftware)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

LIMITATIONS.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Limitations & Honest Caveats
2+
3+
ACF is a useful framework, but it has limitations worth understanding before you invest in it.
4+
5+
---
6+
7+
## The framework is only as good as what the agent can infer
8+
9+
Stage 1 (Onboard) asks the `acf-context-agent` to scan your repository and produce an accurate architecture overview. If your codebase is inconsistent, undocumented, or structurally messy, the generated docs will reflect that. A well-structured document describing a poorly-structured system is better than nothing — but it's not the force multiplier the framework promises.
10+
11+
**What this means in practice:** Run Stage 1 on a reasonably coherent codebase. If your repo is in poor shape, consider a basic cleanup before onboarding.
12+
13+
---
14+
15+
## ADC discipline still requires team buy-in
16+
17+
The generated `AGENTS.md` tells agents when to create an ADC and how to do it. When an agent is executing a task, it will recognise when an ADC is warranted and produce one. However, there is no CI hook or PR check that enforces this for human-authored changes. If a developer ships a significant architectural change without involving an agent, no ADC will be created.
18+
19+
**What this means in practice:** ADC coverage is strongest when agents are doing the work. For human-only changes, a PR review checklist is the most practical enforcement mechanism.
20+
21+
---
22+
23+
## The Review stage (Stage 4) requires an independent perspective
24+
25+
Stage 4 asks you to review the generated documentation without anchoring to the assumptions of the agent that wrote it. The original design required a different model entirely, but the real requirement is independence — not a specific provider.
26+
27+
In practice, a fresh session with the same model eliminates confirmation bias — the model can no longer validate what it previously wrote — and is sufficient for most teams. Switching to a different provider (Gemini, GPT-4o, etc.) gives maximum independence but is optional.
28+
29+
**What this means in practice:** Start a new conversation and run Stage 4 from there. This costs nothing and removes confirmation bias. A different provider is better, but a fresh session is good enough.
30+
31+
---
32+
33+
## Stage 5 (Update) only runs when someone schedules it
34+
35+
Architectural drift is a slow process. Stages 1–4 are not re-run — Stage 5 is the only maintenance path. The framework provides this stage but has no automated trigger. If Stage 5 isn't wired into a recurring workflow, docs will quietly fall behind the codebase and erode trust in the context layer.
36+
37+
**What this means in practice:** Schedule it explicitly — after significant sprints or releases is a good default. A CI scheduled job, a recurring calendar reminder, or a sprint ritual all work. Do not rely on memory. An undocumented codebase is recoverable; a documentation layer that confidently describes the wrong system is worse than nothing.

README.md

Lines changed: 292 additions & 1 deletion
Large diffs are not rendered by default.

WHEN-ACF-WORKS.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# When ACF Works Best
2+
3+
ACF delivers the most value in specific conditions. Understanding where it fits — and where it doesn't — will save you from investing in the wrong place.
4+
5+
---
6+
7+
## It works best on legacy codebases with no documentation and no existing agent integration
8+
9+
This is the highest-value scenario. A legacy codebase with no architecture docs and no AI tooling set up is exactly where ACF delivers the most immediate, tangible return: there's nothing to migrate from, no existing conventions to reconcile, and no agent context to replace.
10+
11+
The `acf-context-agent` generates the entire documentation layer from scratch — architecture overview, deep-dive docs, agent instruction files — directly from the codebase. The team doesn't author anything from scratch. They trigger the agent, review what it produces, and start benefiting immediately.
12+
13+
For teams in this position, ACF is the fastest path from zero context to a working, agent-ready documentation layer.
14+
15+
It works equally well on active codebases that have simply never prioritised documentation.
16+
17+
---
18+
19+
## It works best when agents and developers work together
20+
21+
Developers and agents collaborate most effectively when agents have the context to make good decisions and developers have the confidence to trust and extend what agents produce. ACF provides that shared foundation — developers don't have to constantly correct agents, and agents don't have to guess at patterns and conventions.
22+
23+
Even small amounts of context (starting at Level 1) improve the day-to-day experience. The value compounds as agent involvement deepens.
24+
25+
---
26+
27+
## It is a prerequisite for safe agentic DevOps
28+
29+
As agents move from suggestions to autonomous execution — resolving incidents, migrating systems, raising PRs independently — the risk of operating without architectural context increases dramatically. An agent that doesn't know your auth pipeline, your shared contracts, or your risk triggers isn't just unhelpful, it's dangerous.
30+
31+
For teams moving toward agentic DevOps, ACF is not optional — it's the safety layer.
32+
33+
---
34+
35+
## It is particularly valuable for legacy modernisation
36+
37+
When AI agents help migrate or modernise legacy systems, the biggest risk isn't the technology — it's institutional knowledge loss. Legacy code is full of decisions that made sense at the time: workarounds for vendor limitations, tradeoffs made under constraints that no longer exist, patterns that can't be changed without breaking downstream consumers.
38+
39+
ADCs capture this context before it's lost in translation. Without them, an AI agent will modernise the code and delete the memory.
40+
41+
---
42+
43+
## It is tool-agnostic by design
44+
45+
ACF is markdown in your repo. It works with Claude Code, GitHub Copilot, Gemini CLI, Cursor, Codex, and any future tool that reads file context. You're not buying into a platform or a vendor — you're building a documentation asset that compounds over time.
46+
47+
---
48+
49+
## It does not work well when
50+
51+
- The codebase has no coherent structure for the agent to infer from — Stage 1 will produce weak output
52+
- There is no buy-in from the team — one person maintaining ADCs for a team that ignores them is wasted effort
53+
- AI agents are only used for trivial, low-risk tasks where context doesn't affect output quality
54+
- There is no capacity to run Stage 5 periodically — docs will drift and erode trust in the framework

0 commit comments

Comments
 (0)