Skip to content

Commit 39346b1

Browse files
committed
Update AGENTS.md to include new guideline for executive summaries
- Added a requirement to start documentation with an "Executive Summary" that outlines changes and outcomes for non-technical readers, emphasizing clarity and avoidance of jargon.
1 parent 4075e47 commit 39346b1

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Work style: Be radically precise. No fluff. Pure information only (drop grammar;
2323
- New functionality: small OR absolutely necessary.
2424
- NEVER delete files, folders or other data unless explicilty approved or part of a plan.
2525
- Before writing code, stricly follow the blow research rules
26+
- Always start with "Executive Summary" and summarize the plan for a non-technical reader in a few short bullets (what will change, behavior outcomes, intent, etc), avoiding jargon and implementation details. After that, show the full technical plan with details needed to implement.
2627

2728
## Research
2829
- Always create a spec in-memory (no files), even if minimal

0 commit comments

Comments
 (0)