48 lines
2.4 KiB
Markdown
48 lines
2.4 KiB
Markdown
# Linear-stage report project guidance
|
|
|
|
This repository is the reusable baseline for future linear-stage FAT or
|
|
characterization projects. The active Characterization workflow is the Python
|
|
generator at `Report/python_script/build_characterization_report.py`, launched
|
|
by `Build_Characterization_Report.bat`. Before report work, read
|
|
`Report/AGENTS.md` completely.
|
|
|
|
## Boundaries and evidence
|
|
|
|
- During report generation in a derived project, write only inside `Report/`. Treat `Measurements`,
|
|
`Media`, `Motor`, `Encoder`, `ECMC` and other evidence folders as read-only.
|
|
- Do not execute ECMC example commands or operate hardware to prepare a report.
|
|
- Preserve original filenames, photographs, raw data and measurement PDFs.
|
|
- Preserve `Report/python_script/PSI_Logo.png`; the Python generator displays this logo on
|
|
page 1.
|
|
- Transfer the workbook's repository URL to page 1 under the exact label `Repository`.
|
|
- A template, configuration or successful build is not proof of FAT acceptance.
|
|
- Never fabricate identities, limits, measurements, calibration or uncertainty.
|
|
- For motor report data, inspect `Motor/Motor.xlsx` first when present, then
|
|
use other `Motor/` documents only to resolve fields not supplied by that
|
|
workbook. Keep each reported value traceable to its Motor-folder source.
|
|
|
|
## Privacy
|
|
|
|
Keep confidential/customer evidence within the authorized working environment.
|
|
Do not put secrets in reports, skill assets or workflow state. Do not send
|
|
protected source material to external services without authorization; if the
|
|
requested workflow requires such disclosure, pause that disclosure and obtain
|
|
specific user direction. This does not require approval for ordinary local
|
|
inspection of the evidence already provided for the report.
|
|
|
|
## Efficient continuation
|
|
|
|
The batch launcher uses `uv run --script` and stores its regenerable cache under
|
|
`Report/python_script/uv-cache/`. Keep source code and report-only workflow
|
|
state under `Report/python_script/`; do not add that cache to version control.
|
|
The historical LaTeX assets are archived in `OLD/` and are not active inputs.
|
|
|
|
## Agent boundary
|
|
|
|
An agent may inspect project evidence and update only
|
|
`Report/Agent_Report_Data.json` using the source rules in
|
|
`Report/Report_Input_Manifest.json`. Agent work stops there: do not run the
|
|
batch launcher, build, inspect, or validate a PDF, and do not state that a
|
|
report is complete, issued, accepted, or visually correct. The user runs the
|
|
batch file and reviews the PDF.
|