documentation-templates

A good README starts with a title and one-line description, followed by a quick start section runnable in under five minutes. Then add features, configuration tables, links to detailed docs, contributing guidelines, and license information.

Each endpoint should document the HTTP method and path, a brief description, a parameters table with name, type, required status, and description, possible response codes, and a concrete request/response example.

An llms.txt file is a Markdown file that helps AI crawlers and agents understand your project, containing a one-line objective, core file listings, and key concepts. Add one if you want AI tools to navigate your repository accurately.

Comment the why behind business logic, complex algorithms, non-obvious behavior, and API contracts. Avoid commenting obvious code, every line, self-explanatory statements, or implementation details that the code already expresses.

An ADR contains four sections: Status (Accepted, Deprecated, or Superseded), Context explaining why the decision is needed, Decision describing what was chosen, and Consequences listing the trade-offs.