3 ms·
The key idea here is to write automated tests that check that the core concepts introspected from a codebase are referenced in the documentation. It requires k
by simonw 8y ago
The key idea here is to write automated tests that check that the core concepts introspected from a codebase are referenced in the documentation.
It requires keeping the documentation in the same repository as the code, which I think is a great pattern: it means you can craft single commits that incorporate the code change, the unit tests and the supporting documentation. And if you implement documentation unit tests your code review CI system can help enforce that for you.