📎 Webclip
Software Project Review Checklist
The post says a good software project review report should answer a compact set of questions. Those questions focus on whether releases are documented and automated, how often they happen, how much technical debt exists, whether the delivery pipeline rejects mistakes, and whether code quality, tests, and static analysis are in place. It also asks about documentation, repository ownership, logs, Git history, and how quickly the team responds to tickets.
Reading notes#
- A reviewer’s report should be built from answers to a fixed list of questions.
- The release procedure should be documented, automated, and working.
- Releases should happen frequently, at least once a week.
- Technical debt should be assessed.
- The delivery pipeline should be strong enough to reject mistakes.
- Code quality should be checked through anti-patterns.
- Bugs and features should be registered as tickets.
- Unit test coverage should exist and be visible.
- Work for Hire agreements should be signed with all developers.
- Key architectural decisions should be documented.
- Static analysis should be in place and mandatory for new changes.
- CI should be in place, and its reports should be considered.
- The master branch should be read-only.
- Programming metrics should be collected and reviewed regularly.
- The source code repository should belong to the customer.
- Requirements documentation should be short and up to date.
- Key classes, methods, and functions should have in-code documentation.
- The source code repository should be free of garbage.
- UI/UX interfaces should be documented.
- Production logs should be visible and reviewed regularly.
- The team’s responsiveness to tickets should be checked.
- Git should have a clear history of documented changes.
