Linear Stage FAT and Characterization Reporting
This repository is a starting point for preparing a project-specific factory acceptance test or characterization report for a linear stage. The two report templates and their required workflow are in Report/.
Repository layout
Report/— separate self-contained FAT and Characterization LaTeX templates, the required PSI logo underassets/, and report-specific instructions inAGENTS.md.Measurements/— source measurement reports in PDF format. The report workflow appends every PDF in this folder to the report.Media/— the six report images, named exactlyI1throughI6with.jpg,.jpeg,.png, or.pdfextensions.Motor/— motor or actuator identification and supporting project evidence.Encoder/— encoder identification and supporting project evidence.ECMC/— project-specific ECMC configuration and notes, if applicable. Treat supplied configuration and command records as evidence; do not execute them during report preparation.
Start a new FAT repository
- Create a separate project repository from this template and preserve the template files, including
Report/assets/PSI_Logo.png. - Add project evidence to the appropriate folders. Record exact equipment models, revisions, settings, test conditions, results, and evidence filenames. Identify acceptance criteria for a FAT; characterization does not require pass limits.
- Add the six correctly mapped images to
Media/:I1overall stage,I2encoder,I3motor or actuator,I4coupling,I5test setup view 1, andI6test setup view 2. Do not rename or substitute images to satisfy a missing image requirement. - Add the measurement and analysis PDFs to
Measurements/. Keep original evidence files intact. - Read
Report/AGENTS.mdbefore creating or updating a report. It defines the evidence requirements, template-selection rules, compilation, and page-by-page visual validation workflow. - Select
FATorCharacterizationin the workbook. The agent then usesLinear_Stage_FAT_Report_Template.texorLinear_Stage_Characterization_Report_Template.texdirectly; the templates contain no report-type switch. - Complete
FAT_Checklist.xlsxduring the test. OnRead Me, select the report type, enter the exact stage identifier as text (for example0001), enter the complete repository URL inRepository link, and confirm or edit the project axis convention. Preserve checklist item IDs and wording, select at most one Yes/No response per item, and add factual remarks or evidence references where useful. Provide the saved workbook for report update. - The agent transfers user-entered responses, remarks, report type, stage identifier, repository URL, and coordinate convention into the project-specific report. The URL appears on page 1 under the exact label
Repository. The agent then validates the report and confirms that the PSI logo is visible according toReport/AGENTS.md. Blank responses remain blank and are not inferred.
The templates are not evidence that a particular stage has been tested or accepted. FAT dispositions require applicable acceptance criteria and traceable results, calibration, and uncertainty evidence. Characterization reports present the test scope, methods, and positioning and straightness results without acceptance criteria, uncertainty commentary, observations, or a Conclusions section.
Report skill and continuation
The optional personal Codex skill $fat-stage-report prepares or reviews the
report using this repository's own Report/AGENTS.md and template. Read root
AGENTS.md for evidence boundaries and privacy. Keep evidence unchanged and
use a new report filename when comparing against an existing completed FAT.
The skill stores a hashed evidence inventory, evidence register, appendix order,
checkpoint and separate build/content/visual QA records in
Report/unused/workflow/. This avoids repeated extraction of unchanged sources
without replacing complete source review or final every-page visual inspection.
A working draft with missing evidence is not an issued report or an acceptance.
The helper workflow uses Python 3.10+, Poppler tools and the PC's installed MiKTeX
pdflatex compiler. The report can also be prepared without the skill
by following Report/AGENTS.md directly.
Superseded templates, historical template-validation artifacts, maintenance
scripts, and source-layout references are retained under Report/unused/ and
are not authoritative report inputs.