Skip to content

Reviewer Agent ​

The Reviewer agent performs quality assurance on written chapters, checking for style compliance, technical accuracy, and language quality.

Overview ​

PropertyValue
RoleQuality assurance and feedback
ModelOpus (comprehensive) / Sonnet (quick)
InputChapter file, review criteria
OutputReview feedback with corrections

Full Prompt Template ​

markdown
You are a technical document reviewer. Review the provided LaTeX
chapter for quality, accuracy, and style compliance.

## CHAPTER TO REVIEW
File: latex/chapters/[XX-filename.tex]

## REVIEW CRITERIA

### 1. Content Quality
- [ ] Accurate technical information
- [ ] Logical flow and argumentation
- [ ] Appropriate depth of coverage
- [ ] No factual errors
- [ ] Citations support claims

### 2. Style Compliance
- [ ] Prose style (not bullet-heavy)
- [ ] Academic/scientific tone
- [ ] Consistent terminology
- [ ] Appropriate paragraph length (4-6 sentences)

### 3. Language Quality
- [ ] Proper spelling and grammar
- [ ] Correct accents (if applicable)
- [ ] Clear and concise writing
- [ ] No colloquialisms

### 4. LaTeX Quality
- [ ] Proper use of \cite{}
- [ ] Figures/tables have \caption{} and \label{}
- [ ] No duplicate labels
- [ ] Code blocks properly formatted
- [ ] Within page limit

### 5. Code Blocks
- [ ] Maximum 2-3 per chapter
- [ ] Each under 20 lines
- [ ] Comments in document language
- [ ] Relevant and illustrative

## OUTPUT FORMAT

### Summary
[Overall assessment in 2-3 sentences]

### Issues Found

#### Critical Issues
[Must fix before publication]

#### Major Issues
[Should fix for quality]

#### Minor Issues
[Nice to fix]

### Specific Corrections
[Line-by-line corrections in format:]
- Line XX: "old text" → "new text" (reason)

### Missing Elements
[What should be added]

### Positive Aspects
[What works well]

### Recommendation
[ ] Ready for publication
[ ] Needs minor revisions
[ ] Needs major revisions
[ ] Needs rewrite

Example: Full Review ​

markdown
Comprehensive review of latex/chapters/05-security.tex

CONTEXT:
- Target audience: IT security professionals
- Maximum pages: 8
- Language: Hungarian
- Primary sources: thesis1.pdf, report.pdf

REVIEW FOCUS:
1. Technical accuracy of security concepts
2. Style compliance with AGENT_GUIDELINES.md
3. Language quality (Hungarian accents)
4. LaTeX correctness
5. Citation completeness

Provide detailed review with specific corrections.

Example: Quick Style Check ​

markdown
Quick style review of chapter 05.

CHECK:
1. Count bullet point lists (max 2-3 allowed)
2. Verify Hungarian accents in all text
3. Count code blocks (max 2-3)
4. Check all \cite{} have matching bib entries
5. Verify no duplicate labels

Report issues found.

Output Structure ​

Summary ​

markdown
### Summary

Chapter 05 presents a solid overview of modern security threats
with good technical depth. However, it exceeds the style guidelines
with 7 bullet-point lists and contains 4 missing accent marks.
The content is accurate but needs style revision before publication.

Issues Found ​

markdown
### Issues Found

#### Critical Issues

1. **Duplicate label (Line 45)**
   - `\label{sec:threats}` already exists in Chapter 03
   - Fix: Change to `\label{sec:ch05-threats}`

2. **Missing citation (Line 78)**
   - Claim about "72% of attacks" has no citation
   - Fix: Add `\cite{source2024}` or remove claim

#### Major Issues

1. **Excessive bullet lists (7 found, max 3 allowed)**
   - Lines 23-30: Convert to prose
   - Lines 55-62: Convert to prose
   - Lines 89-95: Convert to prose
   - Lines 110-118: Keep (technical list)
   - Lines 145-150: Convert to prose
   - Lines 180-188: Convert to prose
   - Lines 210-215: Keep (summary)

2. **Code block too long (Line 125-165)**
   - Current: 40 lines
   - Maximum: 20 lines
   - Fix: Extract only essential lines

#### Minor Issues

1. **Missing accent (Line 34)**
   - "biztonsag" → "biztonság"

2. **Missing accent (Line 67)**
   - "felhasznalo" → "felhasználó"

3. **Informal language (Line 92)**
   - "nagyon fontos" → "kritikus jelentőségű"

Specific Corrections ​

markdown
### Specific Corrections

- Line 34: "A biztonsag fontos" → "A biztonság fontos"
- Line 67: "A felhasznalo adatai" → "A felhasználó adatai"
- Line 92: "Ez nagyon fontos" → "Ez kritikus jelentőségű"
- Line 45: `\label{sec:threats}` → `\label{sec:ch05-threats}`
- Line 78: "72% of attacks" → "72\% of attacks \cite{report2024}"

### Bullet List Conversions

**Lines 23-30 (Current):**
```latex
\begin{itemize}
    \item Ransomware támadások
    \item Supply chain támadások
    \item Phishing kampányok
\end{itemize}

Suggested prose:

latex
A modern fenyegetések között kiemelt szerepet kapnak a
ransomware támadások, amelyek mellett a supply chain
támadások és a célzott phishing kampányok jelentik a
legnagyobb kockázatot a szervezetek számára.

### Recommendation

```markdown
### Recommendation

[X] Needs minor revisions

**Required changes:**
1. Fix duplicate label
2. Add missing citation
3. Convert 5 bullet lists to prose
4. Shorten code block to 20 lines
5. Fix 4 accent errors

**Estimated effort:** 30 minutes

After revisions, chapter will meet publication standards.

Review Workflow ​

Review Checklist ​

Content Quality ​

CheckPassFail
Technical accuracyCorrect conceptsErrors found
Logical flowClear progressionDisjointed
Coverage depthAppropriateToo shallow/deep
Factual claimsAll citedUnsupported claims

Style Compliance ​

CheckPassFail
Prose styleFlowing paragraphsBullet-heavy
ToneAcademicInformal
TerminologyConsistentInconsistent
Paragraph length4-6 sentencesToo short/long

Language Quality ​

CheckPassFail
SpellingCorrectErrors
AccentsAll presentMissing
ClarityClearConfusing
RegisterFormalColloquial

LaTeX Quality ​

CheckPassFail
Citations\cite{} usedMissing
LabelsUniqueDuplicates
CaptionsAll presentMissing
Code blocks≤3, ≤20 linesOver limits

Post-Review Actions ​

If Minor Revisions ​

bash
# Apply corrections directly
# Re-compile and verify
./scripts/compile.sh

If Major Revisions ​

markdown
Re-invoke chapter-writer agent with:
- Original requirements
- Review feedback
- Specific issues to address

If Rewrite Needed ​

markdown
Re-invoke chapter-writer agent with:
- Revised outline
- Additional context
- Clearer requirements

Next Steps ​

Multi-Agent Documentation Generation System