eduardo-matos/agents.docs.md

Created February 18, 2026 11:51

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/eduardo-matos/db161201ce7abdca83c4ef2fc1cf06ff.js"></script>
Save eduardo-matos/db161201ce7abdca83c4ef2fc1cf06ff to your computer and use it in GitHub Desktop.

Download ZIP

Example of rules for agents to document code

Raw

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment