Example of rules for agents to document code

agents.docs.md

Documentation rules

Principles

• Document intent, decisions, and contracts.
• Do not document what is obvious from code.
• Optimize for future maintainers.

Must Document

• Architecture decisions
• Module boundaries
• Public APIs & contracts
• Business rules
• Non-obvious flows

Must Not Document

• Trivial functions
• Framework behavior
• Generated code
• Low-level implementation details

README Rules

• Explain:

  • what the system does
  • how it is structured
  • how to run
  • how to test

Update Discipline

• Update docs together with code changes.

AI Rules

• Prefer concise, intent-driven docs.
• If intent is unclear, ask for clarification.