Product documentation
Describes available features, limits, data processing and operational flows. It is checked against the published software.
Editorial rules
Who writes, what is checked and how to report an error.
Product documentation is checked against the published software. Organisational guides declare author and limits. Clinical content can be labelled as such only when it names its sources and an identifiable qualified reviewer.
- Declared authorEach guide identifies its editorial or professional responsibility.
- Explicit scopeGeneral information is not confused with clinical advice.
- Verifiable sourcesTechnical claims refer to primary sources when needed.
- Open correctionsReported errors are reviewed and corrected when confirmed.
Three categories
The level of review depends on the content.
Organisational guides
Provide general methods for organising a plan, diary or follow-up. They do not contain personalised prescriptions.
Clinical content
When published, it must identify scientific sources and a qualified, identifiable reviewer. Without that review it is not presented as clinical guidance.
Editorial process
Five checks before and after publication.
Define
Set the audience, question and boundaries.
Source
Prefer official documentation, law and primary research.
Verify
Check features, claims and links before publication.
Attribute
Declare the author, any reviewer and the limits.
Update
Change dates only after a verified substantive revision.
Artificial intelligence
An automated draft is not a review.
Automated tools may help organise or translate an initial draft. Before publication, text, cited features, links, limitations and structured data are checked. An AI system is not identified as a healthcare reviewer.
Corrections and feedback.
Email [email protected] with the URL, affected passage and a useful source. The report is reviewed; confirmed errors are corrected and the modification date is updated.