A bit of inspiration most weekdays for exploring your mindset .

Treat documentation as code if not better

Khem Raj February 04, 2025 #meta

Documentation is the API, in code-speak, for your software to be used, so it should have same rigors as codebase.

If we do not push untested code commits, we should not commit outdated or ambiguous documentation

If we use version control for codebase, we should use one for documentation too

If we have review process e.g. Github PRs for code, we should have one for documentation too

If we have CI for code, we should have CI for documentation as well, so we can catch broken links, formatting etc.

Keep documentation as close as possible to the codebase, your future self and teams will thank you for setting up first class documentation development workflow.