The documentation should be accessible via a web browser.
The link to the docs website should be included in the README.
The docs should contain correct information about all endpoints in the service.
The documentation should be interactive.
The docs should contain guides on implementing the most common tasks.
All the documentation (guides and reference) should be on a single website.
The raw docs should be included in the codebase.
Devs should be able to easily set up the docs on local.
Each deployed environment should have its own docs
The documentation should be hosted at docs.<service-domain>
The documentation workflow should automate as many things as possible.
The workflow should block deploys if the docs are incorrect.
The workflow should be documented in the codebase’s README.
The docs site should only be accessible by everyone in the company.
The tools used should be free or cost up to $400/mo if they save time significantly.