https://github.com/srws-psg/protocol-templates
A collection of Markdown-based systematic review (SR) protocol templates, maintained by SRWS-PSG. Successor to the protocols.io V.2 intervention-review template.
https://github.com/srws-psg/protocol-templates
cochrane markdown pandoc prisma protocol srws-psg systematic-review template
Last synced: 14 days ago
JSON representation
A collection of Markdown-based systematic review (SR) protocol templates, maintained by SRWS-PSG. Successor to the protocols.io V.2 intervention-review template.
- Host: GitHub
- URL: https://github.com/srws-psg/protocol-templates
- Owner: SRWS-PSG
- License: other
- Created: 2026-05-16T06:13:25.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-06-05T06:31:12.000Z (17 days ago)
- Last Synced: 2026-06-05T08:12:34.127Z (17 days ago)
- Topics: cochrane, markdown, pandoc, prisma, protocol, srws-psg, systematic-review, template
- Language: TeX
- Size: 3.94 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Citation: CITATION.cff
- Zenodo: .zenodo.json
Awesome Lists containing this project
README
# SRWS-PSG protocol templates
A collection of Markdown-based systematic review (SR) protocol templates, maintained by [SRWS-PSG](https://srws-psg.org/) (Scientific Research WorkS Peer Support Group).
Templates currently included:
- [`templates/intervention-review/`](templates/intervention-review/) — SR protocol for **intervention reviews** (the V.3 successor of the protocols.io V.2 template).
- [`templates/scoping-review/`](templates/scoping-review/) — protocol for **scoping reviews**, structured per the JBI five-stage methodology and the [Peters et al. 2022 best-practice checklist](https://doi.org/10.11124/JBIES-21-00242). Reporting follows [PRISMA-ScR](https://doi.org/10.7326/M18-0850).
(More template types — diagnostic test accuracy, qualitative evidence synthesis, etc. — will be added under `templates/` as separate sub-directories.)
The templates are designed to be:
- **Version-controlled** — every change is tracked, every release is permanent.
- **Citable** — each GitHub release gets a Zenodo DOI automatically.
- **Reusable** — fill in the `??????` placeholders with your own SR plan; render to docx / PDF / HTML via Pandoc.
## Citing this template
Use the DOI of the **release** you actually downloaded. The "concept DOI" below always resolves to the latest version.
- Concept DOI (always points to the latest release): [`10.5281/zenodo.20586625`](https://doi.org/10.5281/zenodo.20586625)
- Version DOIs are listed in [CHANGELOG.md](CHANGELOG.md) once minted.
For the rationale and design of each template, see the companion explanation article on Zenodo *(to be published as part of [Step 4 of the publication plan](plan.md))*.
> **Historical note (intervention-review template)**: Versions up to V.2 (2022-08-26) were published on protocols.io: (DOI [10.17504/protocols.io.81wgbpb41vpk/v2](https://dx.doi.org/10.17504/protocols.io.81wgbpb41vpk/v2)). From v3.0.0 onward this template is maintained here on GitHub.
## Quick start
```bash
git clone https://github.com/SRWS-PSG/protocol-templates
cd protocol-templates
pwsh ./templates/intervention-review/build.ps1 -Target docx # or html, or pdf
# Scoping review template:
pwsh ./templates/scoping-review/build.ps1 -Target docx
```
Edit [templates/intervention-review/protocol_template_for_intervention_review.md](templates/intervention-review/protocol_template_for_intervention_review.md) or [templates/scoping-review/protocol_template_for_scoping_review.md](templates/scoping-review/protocol_template_for_scoping_review.md) and replace the `[English label / 日本語ラベル: ...]` placeholders with your own SR plan. Each template owns its own `references.bib` (Vancouver style via Pandoc + citeproc) — do not consolidate across templates.
## Repository layout
```
.
├── README.md # this file
├── LICENSE # CC BY 4.0
├── CHANGELOG.md # version history (covers all templates)
├── CITATION.cff # GitHub "Cite this repository" metadata
├── .zenodo.json # Zenodo deposit metadata
├── plan.md # internal publication plan (working doc)
├── CLAUDE.md # Claude Code working notes
├── resources/ # historical reference (protocols.io V.2 PDF, original docx)
└── templates/
├── intervention-review/
│ ├── protocol_template_for_intervention_review.md # the template (source, EN)
│ ├── protocol_template_for_intervention_review.ja.md # JA master
│ ├── references.bib # BibTeX (intervention-only)
│ ├── comments.yaml # mentoring comments injected to Google Doc
│ ├── build.ps1 # Pandoc build script
│ └── build/ # generated artifacts (gitignored)
└── scoping-review/
├── protocol_template_for_scoping_review.md # the template (source, EN)
├── protocol_template_for_scoping_review.ja.md # JA master
├── references.bib # BibTeX (scoping-only, INDEPENDENT)
├── comments.yaml # mentoring comments injected to Google Doc
├── media/scoping_concept_focus.png # JBI Terminology-vs-Concept figure
├── build.ps1 # Pandoc build script
└── build/ # generated artifacts (gitignored)
```
## Authors
- Yuki Kataoka
- Ryuhei So
- Masahiro Banno
- Yasushi Tsujimoto
- SRWS-PSG Mentors
## License
Released under the [Creative Commons Attribution 4.0 International License](LICENSE).