Workspace · Review path

Development docs · 996102e0
View source

Manuscript review path

Use this route when the analysis is already complete enough to draft a manuscript but you want one compact map from result interpretation → manuscript wording → reviewer reconstruction → post-review amendment → response package → archive verification. The revision-package stage makes that archive verification executable: it scaffolds the response matrix, version-change manifest, post-review evidence layers, software record, and editor-facing evidence map before the final handoff.

Already in a revision round? Use the peer-review revision toolkit for the shorter task-based route: classify the request, preserve new evidence, write the response, record version changes, build the executable revision package, and run the resubmission gate.
1 · Interpret

Check denominator, endpoint, direction, magnitude, descriptive sensitivity, and unresolved uncertainty.

2 · Draft

Write Methods, Results, and limitations so the complete observed pattern remains visible.

3 · Reconstruct

Ask whether an outsider can recover the endpoint, valid denominator, failures, amendments, and software identity.

4 · Amend

If peer review requests new work, preserve the submitted record and add the revision as dated, separately denominated evidence.

5 · Respond

Link each reviewer item to its category, timing, action, evidence, manuscript location, and archived revision record.

6 · Archive

Scaffold and validate the revision package, finalize the resubmission handoff, then verify the publication bundle, change manifest, evidence map, fingerprints, revision evidence, response record, and final claim-supporting files.

Use these pages in order

  1. Interpret an audit result
  2. Reporting robustness
  3. Manuscript readiness checklist
  4. Reviewer reconstruction example
  5. Reviewer-requested amendments
  6. Reviewer-requested reanalysis example
  7. Reviewer response letter guide
  8. Revision response package example
  9. Version-change manifest guide
  10. Revision reproducibility package
  11. Reproducibility-package worked example
  12. Resubmission readiness and editor handoff
  13. Submission-to-accepted-record example
  14. Reproducible publication workflow

Review-round kit

Classify the request

Separate clarification, correction, sensitivity, analytical, endpoint, and measurement amendments before changing the record.

Amendment guide →

Preserve the new evidence

Record outcome-inspection timing, the amendment-specific specification space, execution denominator, failures, and software identity.

Reanalysis example →

Write the response

Connect each reviewer item to the exact manuscript and archive changes without converting post-review work into false pre-specification.

Response-letter guide →

Reconstruct the final package

Verify that an outsider can trace the submitted evidence, revision evidence, manuscript change log, and final publication claim.

Response-package example →

Final resubmission handoff

Record what changed

Use stable change IDs to distinguish editorial edits, clarifications, corrections, analytical amendments, endpoint changes, and reporting-boundary changes.

Version-change manifest →

Build the reproducibility package

Use the real CLI to scaffold the response matrix, version manifest, amendment layers, software record, and final evidence map, then validate the structural manifest.

Revision package guide →

Run the final consistency gate

Check that response wording, temporal denominators, revised manuscript locations, archive evidence, software identity, and unresolved limitations agree.

Resubmission readiness →

Trace the accepted record

Practise the complete synthetic route from submitted 8/8 evidence through a 4/4 review amendment to the final editor-facing evidence map.

Accepted-record example →

For practice, compare the result-pattern examples, work through the reviewer reconstruction example, then use the reviewer-requested reanalysis example, revision response package example, reproducibility-package worked example, and submission-to-accepted-record example to practise preserving submitted, post-review, and final evidence as separate temporal layers.

Revision is an extension, not a rewrite. A reviewer-requested exclusion, threshold, endpoint, measurement assumption, or sensitivity branch should not be inserted retrospectively into the submitted declaration. Preserve the submitted denominator, record when outcomes had already been inspected, and give the amendment its own execution status and provenance. If review reveals a correction, preserve the superseded record and identify which final claims were regenerated.
The route does not classify your study. Structural validation is not scientific validation. The revision-package validator checks expected files and manifest integrity. It does not classify the study, judge whether the specification space is defensible, predict acceptance, or convert editorial status into empirical evidence.

Documentation search

Find the right documentation

↑↓ navigateEnter openEsc close