agentic-workflows-blueprint.workflow.review
Goal
Review documentation quality and correctness with deterministic pass/fail criteria.
Scope
- Applies to: docs produced by the
documentworkflow. - Does not cover: implementing code fixes outside documentation scope.
Triggers
- "Review this documentation output"
- "Check if document is correct"
- Automatic review step after
document
Inputs
docTargetsourceEvidence(diff/files used by document workflow)maxDocumentRetries(default: 3)currentAttempt(1..3)
Invariants
- Review must be evidence-based and actionable.
- Every failure must include concrete fix instructions.
- Keep feedback concise and unambiguous.
- For infra/network/IaC/OS docs, review must validate command evidence, operational safety notes, and rollback completeness.
Procedure
- Validate documentation claims against
sourceEvidence. - Check structure clarity and required sections.
- For infrastructure documentation, verify presence of:
- pre-change assumptions;
- post-change validation output;
- rollback readiness and known residual risks.
- Return one of:
PASS: no blocking issues;FAIL: list exact issues and required fixes.
- If
FAILandcurrentAttempt < maxDocumentRetries, route back todocumentwith feedback. - If
FAILand retry limit reached, stop the chain and mark as unresolved.
Outputs
reviewStatus:PASSorFAILreviewFindings: concise issue list with fix instructionsnextAction:run_changelog,rerun_document, ormanual_intervention
Review gate
- Every
FAILitem includes specific correction guidance. - Final verdict maps directly to a next action.
- Retry rule (
<= 3) is enforced.
References
../../SKILL.md../document/SKILL.md- Interactive HTML View