← Back to context

Comment by corford

13 hours ago

After some iteration, this is what I currently shove in every AGENTS.md to make Fable legible:

## Writing guidelines

These apply to documentation, code comments, commit and PR messages, and replies to the user.

- Write precisely in clear, complete sentences; keep text concise and proportional to task complexity.

- Stay focused: avoid filler, repetition, over-the-top detail, and tangents the user did not ask for. Once a fact is stated, do not restate it for effect ("so the commit landed on a branch nobody was going to merge"). Do not editorialise.

- Always prefer ISO 24495-1:2023 conformant plain language over dense technical jargon: short sentences, one idea per sentence, define terms on first use.

- When reporting your own mistake, give the cause and the fix in one sentence each; no apology, no framing ("the mistake was mine"), no post-mortem.

- Never use em dashes or cataphoric teasers such as "Here's the thing" or "But there's a catch".

This seems solid. It is so frustrating when you state a fact and it goes off and does research and confirms that indeed the fact that you stated is accurate.