skills/scientific-writing/references/reporting_guidelines.md
Reporting guidelines help authors report study design, conduct, analysis, and findings completely enough for appraisal. They do not make a study rigorous, replace a protocol, repair missing methods, appraise risk of bias, certify compliance, or predict acceptance. The bundled selector and coverage checker are deliberately non-scoring [SW-S06, SW-S12].
Always open the current official statement, checklist, explanation-and-elaboration document, relevant extensions, and target-journal instructions. The bundled registry is a dated routing aid, not a copy of any official checklist.
For AI intervention trials or protocols, check CONSORT-AI or SPIRIT-AI in addition to the current parent statement. For routinely collected data, harms, equity, patient- reported outcomes, clusters, noninferiority, pilot studies, and other special designs, search EQUATOR for a current extension [SW-S06].
Use the offline registry:
python3 scripts/select_reporting_guidelines.py select --study-design randomized_trial
python3 scripts/select_reporting_guidelines.py select --study-design randomized_trial --protocol
python3 scripts/select_reporting_guidelines.py select --study-design diagnostic_accuracy --ai
python3 scripts/select_reporting_guidelines.py select --study-design prediction_model --ai --llm
The result is a candidate set. A human must confirm:
If no local match exists, search the official EQUATOR library rather than forcing the nearest guideline.
The bundled coverage_topics are original high-level prompts. They do not reproduce
official item wording or numbering.
For each topic, record:
addressed, with manuscript locations;not_applicable, with a rationale;missing.Then run:
python3 scripts/select_reporting_guidelines.py check reporting_coverage.json
A pass means every bundled topic has an allowed status and location or rationale. It does not mean every official checklist item is satisfied or well reported.