LBaC
AGENTS.md0 starsChanged 4 months agoMITView on GitHub
This file contains the development guidelines, architecture conventions, and token optimization rules for AI agents assisting in this repository. MANDATORY FIRST STEP: Before initiating any development task, you must read the Master Blueprint of the project: π docs/LBAC.md The Master Blueprint is the Single Source of Truth (SSoT) of this repository. It links to all Feature Maps (As-Is/To-Be), Architectural Decision Records (ADRs), Business Rules, Sprint Schedules, and BDD Acceptance Criteria. Mandatory workflow for any coding task: 1. Read the relevantβ¦
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository4 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/lbac_rules.mdcCursor rule
- requirements-elicitationSkill
The file
Show its rules and text
We split this AGENTS.md into the rules it gives an agent
13 rules. About 0 are common, 3 are distinctive, and 10 are very specific to this project.
β0
Common Β· estimate
Many files like this have a rule of this kind.
β3
Distinctive Β· estimate
This author's own choices. Worth a look.
10
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 15
Read the relevant feature map in docs/features/.
- Very specific: line 16
Check the technical debt log in docs/technical_debt.md for any related cleanups.
- Very specific: line 19
Before coding: Create an Implementation Plan in docs/implementations/ using Template 4 from docs/LBAC.md.
- Very specific: line 24
Traceability Updates: When creating or renaming any source file, search all markdown files in docs/ and update their file:/// links to β¦
- Very specific: line 25
Technical Debt Sync: When completing a task that resolves a task listed in docs/technical_debt.md, automatically: (1) move the task from β¦
- Very specific: line 27
Blueprint Index Sync: When creating a new Feature Map, ADR, or Business Rule file, automatically add it to the corresponding index table in β¦
- Very specific: line 28
ADR Status Sync: When a decision is superseded by a new ADR, update the old ADR's Status field to Superseded by ADR-YYY and update its row β¦
- Very specific: line 29
Stale Verification Report Alert: If a Feature Map's "To-Be" section is modified after a Verification Report already exists for that story, β¦
- Very specific: line 30
Gateway File Consistency: When a core workflow rule in this file (.agents/AGENTS.md) changes significantly, propagate the change summary to β¦
- Distinctive: line 47
Localized Edits (No Full Rewrites): When suggesting code changes, never output the entire file.
- Distinctive: line 48
Do Not Explain the Obvious: Do not explain language syntax, standard library features, or basic framework architecture concepts unless β¦
- Distinctive: line 49
Surgical Search: Use search and read tools selectively.
- Very specific: line 50
No Placeholders: Write complete code segments for implementation.
β βCommonβ is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. βVery specificβ is our guess from the words: it names a file, a command, a setting or the project itself.
Files
π€ Project Rules and AI Agent Context
This file contains the development guidelines, architecture conventions, and token optimization rules for AI agents assisting in this repository.
π 0. Living Blueprint-as-Code (LBaC) Framework
MANDATORY FIRST STEP: Before initiating any development task, you must read the Master Blueprint of the project: π docs/LBAC.md
The Master Blueprint is the Single Source of Truth (SSoT) of this repository. It links to all Feature Maps (As-Is/To-Be), Architectural Decision Records (ADRs), Business Rules, Sprint Schedules, and BDD Acceptance Criteria.
Mandatory workflow for any coding task:
- Read the relevant feature map in
docs/features/. - Check the technical debt log in
docs/technical_debt.mdfor any related cleanups. - Respect the technical constraints defined in this file.
- Do not create models, screens, classes, or database tables without first verifying if they already exist in the codebase.
- Before coding: Create an Implementation Plan in
docs/implementations/using Template 4 fromdocs/LBAC.md. Present it to the user and wait for explicit approval. - After coding: Complete a Verification Report using Template 5 from
docs/LBAC.md, confirming all BDD scenarios from the feature map pass successfully. - Log any technical debt or significant architectural decisions found during development.
π AI Auto-Documentation & Synchronization Rules:
- Traceability Updates: When creating or renaming any source file, search all markdown files in
docs/and update theirfile:///links to match the new paths. - Technical Debt Sync: When completing a task that resolves a task listed in
docs/technical_debt.md, automatically: (1) move the task from "Pending Tasks" to "Resolved Tasks" with a resolution summary, AND (2) remove or annotate the corresponding entry in the Feature Map's## π οΈ Related Technical Debtsection. - Sprint History Sync: Upon completing a story, update
docs/planning/sprint_history.mdto mark the story as completed ([x]) and record any key architectural decisions made. When closing a sprint, also update the sprint table indocs/planning/proposal_planning_qa.md. - Blueprint Index Sync: When creating a new Feature Map, ADR, or Business Rule file, automatically add it to the corresponding index table in
docs/LBAC.md. - ADR Status Sync: When a decision is superseded by a new ADR, update the old ADR's
Statusfield toSuperseded by ADR-YYYand update its row in thedocs/LBAC.mdindex accordingly. - Stale Verification Report Alert: If a Feature Map's "To-Be" section is modified after a Verification Report already exists for that story, add a
β οΈ Requires Re-verificationwarning to the top of the existing Verification Report indocs/implementations/. - Gateway File Consistency: When a core workflow rule in this file (
.agents/AGENTS.md) changes significantly, propagate the change summary to the gateway files:CLAUDE.md,.github/copilot-instructions.md,.cursor/rules/lbac_rules.mdc, and.windsurfrules.
π― 1. Project Purpose & Core Domain
- Project Name: Living Blueprint-as-Code (LBaC) β Template Repository
- Purpose: A methodology and repository template that turns product specs, architectural decisions, roadmaps, and QA strategies into active, versioned code documents. Acts as the Single Source of Truth (SSoT) for human developers and AI coding agents to align on a project's state without ambiguity.
- Core Tech Stack: Markdown (documentation), Git (version control). Agnostic by design β the framework can wrap any application tech stack (e.g., Node.js/Express, Spring Boot, Flutter, Next.js, PostgreSQL).
β‘ 2. Rules for Token and Credit Optimization (Efficient Consumption)
To save context tokens, minimize API costs, and improve response speed, the AI agent must strictly comply with:
- Ultra-Concise Responses: Get straight to the point. Avoid long intros, repetitive greetings, or generic conclusions. Assume the user is an experienced developer.
- Localized Edits (No Full Rewrites): When suggesting code changes, never output the entire file. Provide specific code snippets, replacement blocks, or standard unified diffs.
- Do Not Explain the Obvious: Do not explain language syntax, standard library features, or basic framework architecture concepts unless explicitly asked.
- Surgical Search: Use search and read tools selectively. Read only the line ranges you need.
- No Placeholders: Write complete code segments for implementation. Do not use comments like
// TODO: implement this laterunless specifically directed.
π οΈ 3. Technical Constraints & Conventions
- File Linking: In your responses, always format file paths as clickable links using the
file:///scheme and forward slashes (e.g., README.md). - Documentation Language Rules:
- English:
docs/LBAC.md,docs/features/*.md,docs/technical_debt.md,docs/planning/sprint_history.md,.agents/AGENTS.mdβ these files are consumed directly by the AI to keep token tokenization efficient (~15-25% savings). - Local Language (e.g., EspaΓ±ol):
docs/business/*.md,docs/planning/*_qa.md,docs/adr/*.mdβ these files are mostly consumed by human stakeholders.
- English:
- Architecture Flow: Feature Map ββ> Implementation Plan ββ> Source Code ββ> Verification Report ββ> Sprint History & Technical Debt Register
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

