Documentation prompts: Code Audit

Test whether a newcomer can run the project.

Code Audit / Documentation

Check examples, errors and versioning information.

Code Audit / Documentation

Check whether decisions and reasons are recorded.

Code Audit / Documentation

Check that an operator at 3 a.m. can follow it.

Code Audit / Documentation

Check API documentation accuracy against the code and find places where the docs and the real behaviour differ.

Code Audit / Documentation

Check that comments help rather than mislead.

Code Audit / Documentation

Check diagrams and decision records against reality.

Code Audit / Documentation

Check that notes tell users what changed and what to do.

Code Audit / Documentation

Check that expectations for contributors are clear.

Code Audit / Documentation

Check that every field is defined, typed and owned.

Code Audit / Documentation

Documentation Code Audit