Codexana
Contact

Line C · Run

Useful resources

Tools and references for teams who want their software to be easier to understand, change and hand over.

Legibility audit

Answer six questions about a product you own. The chart shows where clarity is strong and where it may be costing you time.

1. Could a new developer guess what most files and functions do from their names?
2. Is there up-to-date documentation on how to run and deploy the product?
3. Do automated tests describe the important business rules?
4. Do interface labels use the same words your customers use?
5. Do error messages tell users what to do next?
6. Could someone outside the original team take over within a week?

Answer the questions to see your read-out.

Answers are stored on this device only if you accept optional storage.

Glossary

Accessibility
Designing so people with a wide range of abilities can use a product, including those using assistive technology.
API
A defined way for one piece of software to request data or actions from another.
Code review
A second developer reading a change before it is accepted.
Continuous integration
Automatically building and testing code each time it changes.
Dependency
Third-party code your product relies on.
Information architecture
How content and features are organised and labelled.
Regression
A fault where something that used to work stops working.
Rollback
Returning to the previous working version after a problem.
Run-book
Written instructions for operating a system: deploy, back up, restore.
Technical debt
Shortcuts in code that make future change slower or riskier.

Trusted guidance

Image credits

Photographs on this site are illustrative stock images from Unsplash and Pexels, used under their licences. They do not depict Codexana staff, premises or projects.