Files
MastersThesis/.claude/commands/documentation-review.md

75 lines
3.3 KiB
Markdown
Raw Normal View History

2026-01-20 11:35:56 +01:00
Review and validate the documentation for this Master's Thesis project.
## Instructions
1. **Read metrics source files first** to get the correct values:
- `docs/metrics/metrics_paddle.md` - PaddleOCR results
- `docs/metrics/metrics_doctr.md` - DocTR results
- `docs/metrics/metrics_easyocr.md` - EasyOCR results
- `docs/metrics/metrics.md` - Comparative summary
- `src/results/*.csv` - Raw data from 64 trials per service
2. **Review UNIR guidelines** for formatting and structure rules:
2026-01-20 12:11:34 +01:00
- **`instructions/plantilla_individual.htm`** - **PRIMARY REFERENCE** for all styling (CSS classes, Word styles)
- **`instructions/plantilla_individual_files/`** - Support files with additional style definitions
2026-01-20 11:35:56 +01:00
- `instructions/instrucciones.pdf` - TFE writing instructions
2026-01-20 12:11:34 +01:00
- `instructions/plantilla_individual.pdf` - Official template preview
**IMPORTANT:** When styling elements (tables, figures, notes, quotes), ALWAYS check `plantilla_individual.htm` for existing Word/CSS classes (e.g., `MsoQuote`, `MsoCaption`, `Piedefoto-tabla`). Use these classes instead of custom inline styles.
2026-01-20 11:35:56 +01:00
3. **Validate each documentation file** checking:
### Data Accuracy
- All CER/WER values must match those in `docs/metrics/*.md`
- Verify: baseline, optimized, best trial, percentage improvement
- Verify: GPU vs CPU acceleration factor
- Verify: dataset size (pages)
### UNIR Formatting
2026-01-20 11:49:51 +01:00
- Tables: `**Tabla N.** *Descriptive title in italics.*` followed by table, then `*Fuente: ...*`
- Table titles must describe the content (e.g., "Comparación de modelos OCR")
- Figures: `**Figura N.** *Descriptive title in italics.*`
- Figure titles must describe the content (e.g., "Pipeline de un sistema OCR moderno")
2026-01-20 11:35:56 +01:00
- Sequential numbering (no duplicates, no gaps)
- APA citation format for references
### Mermaid Diagrams
- **All diagrams must be in Mermaid format** (no external images for flowcharts/charts)
- All Mermaid diagrams must use the UNIR color theme
- Required YAML frontmatter config (Mermaid v11+):
```mermaid
---
title: "Diagram Title"
config:
theme: base
themeVariables:
primaryColor: "#E6F4F9"
primaryTextColor: "#404040"
primaryBorderColor: "#0098CD"
lineColor: "#0098CD"
---
flowchart LR
A[Node] --> B[Node]
```
- Colors: `#0098CD` (UNIR blue for borders/lines), `#E6F4F9` (light blue background)
2026-01-20 11:49:51 +01:00
- All diagrams must have a descriptive `title:` in YAML frontmatter
2026-01-20 12:11:34 +01:00
- Titles MUST be quoted: `title: "Descriptive Title"` (not `title: Descriptive Title`)
2026-01-20 11:49:51 +01:00
- Titles should describe the diagram content, not generic "Diagrama N"
2026-01-20 11:35:56 +01:00
- Verify theme is applied to all diagrams in `docs/*.md`
### Files to Review
- `docs/00_resumen.md` - Resumen/Abstract
- `docs/03_objetivos_metodologia.md` - Objectives
- `docs/04_desarrollo_especifico.md` - Main results (most critical)
- `docs/05_conclusiones_trabajo_futuro.md` - Conclusions
- `docs/07_anexo_a.md` - Technical annex
- `README.md` - Project overview
4. **Report findings** with:
- List of incorrect values found (with file:line references)
- Formatting issues detected
- Specific corrections needed
- Overall documentation health assessment
5. **Language**: All docs/* files must be in Spanish. README.md and CLAUDE.md can be in English.