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, a configuration table, links to detailed docs, contributing guidelines, and license information in that priority order.

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

An llms.txt file is a Markdown file that gives AI crawlers and agents a concise map of your project, including a one-line objective, core file paths, and key concepts. It improves how AI tools index and understand your documentation.

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 stating what was chosen, and Consequences describing the trade-offs involved.