FAT-Test-with-template/README.md

Linear Stage Factory Acceptance Test (FAT)

This repository is a starting point for preparing a project-specific factory acceptance test report for a linear stage. The report template and its required workflow are in Report/.

Repository layout

• Report/ — LaTeX report template and report-specific instructions in AGENTS.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 exactly I1 through I6 with .jpg, .jpeg, .png, or .pdf extensions.
• 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. runCommands.txt contains example commands and host paths; verify and adapt them before use.

Start a new FAT repository

1. Create a separate project repository from this template and preserve the template files.
2. Add project evidence to the appropriate folders. Record exact equipment models, revisions, settings, acceptance criteria, test conditions, results, and evidence filenames.
3. Add the six correctly mapped images to Media/: I1 overall stage, I2 encoder, I3 motor or actuator, I4 coupling, I5 FAT setup view 1, and I6 FAT setup view 2. Do not rename or substitute images to satisfy a missing image requirement.
4. Add the measurement and analysis PDFs to Measurements/. Keep original evidence files intact.
5. Read Report/AGENTS.md before creating or updating a report. It defines the evidence requirements, template rules, compilation, and page-by-page visual validation workflow.
6. Create a project-specific report from Report/Linear_Stage_FAT_Report_Template.tex; do not overwrite the template. Keep all checklist response fields blank for the user.

The template is not evidence that a particular stage has been tested or accepted. A report disposition must be supported by applicable acceptance criteria and traceable results, calibration, and uncertainty evidence.