2026-11-02 11:30:00 +01:00
up
2026-11-02 10:34:40 +01:00
up
2026-10-26 16:56:57 +01:00
up
2026-10-26 16:56:57 +01:00
up
2026-10-26 16:56:57 +01:00
up
2026-10-26 16:56:57 +01:00
up
2026-11-02 11:30:00 +01:00
up
2026-11-02 10:34:40 +01:00
up
2026-11-02 10:34:40 +01:00
up
2026-11-02 10:34:40 +01:00
up
2026-11-02 11:30:00 +01:00

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 plus 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. Treat supplied configuration and command records as evidence; do not execute them during report preparation.

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, test conditions, results, and evidence filenames. Identify acceptance criteria for a FAT; characterization does not require pass limits.
  3. Add the six correctly mapped images to Media/: I1 overall stage, I2 encoder, I3 motor or actuator, I4 coupling, I5 test setup view 1, and I6 test 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-selection rules, compilation, and page-by-page visual validation workflow.
  6. Select FAT or Characterization in the workbook. The agent then uses Linear_Stage_FAT_Report_Template.tex or Linear_Stage_Characterization_Report_Template.tex directly; the templates contain no report-type switch.
  7. Complete FAT_Checklist.xlsx during the test. On Read Me, select the report type, enter the exact stage identifier as text (for example 0001), 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.
  8. The agent transfers user-entered responses, remarks, report type, stage identifier, and coordinate convention into the project-specific report, then validates it according to Report/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.

S
Description
This template is to be used for FAT of linear stages at the Mechatroncis Lab.
Readme
463 KiB
0 Stars 0 Watchers 0 Forks
Languages
TeX 99.1%
Python 0.9%