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 in that priority order.

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 document that gives AI crawlers and agents a concise overview of your project, listing core files and key concepts. It improves how AI tools index and understand your repository.

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 documents a single architectural decision with four parts: status (accepted, deprecated, or superseded), context explaining why the decision was needed, the decision itself, and the consequences including trade-offs.