Documentation
Everything in one place
For the people who use it, the people who run it, and the people who have to sign that it is fit for use. Every document is a Markdown file in the repository, so it is versioned with the code it describes.
/
Use it
User guideEvery screen and every action, with screenshots: for the people who create, confirm and approve records.Migrating from another systemBring records over from the system you use today: mapping, rehearsal, cut-over, reconciliation report.Migration assistantReplace an existing application: survey its repository, get a parity and gap analysis, drafted configuration and mapping, a read-only export, a rehearsal and a field-by-field verification.Example migrationA small export from an imaginary system and the mapping that imports it, with rows that fail on purpose.Example system to migrate fromAn invented supplier register with schema, code and settings: the worked example of the migration assistant.
Set it up
Developer setupFrom a clone to a running server, the tests, the project layout and how to extend it.ConfigurationDescribe your own domain: record types, fields, hierarchy, roles and permissions.Example configurationA complete configuration for laboratory equipment, to copy and adapt.StoragePostgreSQL, SQLite, file and memory stores; schema, privileges, backup.Sign-inMicrosoft Entra ID, any OpenID Connect provider, an authenticating proxy; roles and signatures.DeploymentEvery environment variable, Docker, reverse proxy, hardening checklist.OperationsThe command-line tool, monitoring, integrity checks, backup and restore.
Understand it
Validate it
Validation packWhat the pack contains, who is responsible for what, and where to start reading.Validation planCS-VAL-01: scope, approach, roles, deliverables, acceptance.User requirementsCS-VAL-02: what an organisation needs from the system.Functional specificationCS-VAL-03: what the software does, requirement by requirement.Risk assessmentCS-VAL-04: hazards, technical and procedural controls, residual risk.Traceability matrixCS-VAL-05: every requirement and the tests that verify it; generated from the test sources.Installation qualificationCS-VAL-06: is it installed as specified?Operational qualificationCS-VAL-07: does every function work as specified? Automated and manual cases.Performance qualificationCS-VAL-08: does it work in your process, with your configuration?21 CFR Part 11 and EU Annex 11CS-VAL-09: clause by clause, what the software supports and what stays with you.Data integrity and the audit trailCS-VAL-10: ALCOA+, the audit entry, the hash, how to verify it yourself.Procedure templatesCS-VAL-11: the procedures an organisation needs around the system.Supplier assessmentCS-VAL-12: how the software is built and what the project does not provide.