mg-industrial-equipment-manual-builder

A reusable Codex skill for producing professional Chinese or bilingual HTML manuals for industrial and non-standard equipment.

The skill focuses on the parts that make non-standard machine manuals hard to repeat well:

• managed project folders and source-of-truth documents,
• SFC / timing review before HMI parameter explanations,
• bilingual image annotation without redrawing real machine photos,
• concise customer-facing Chinese and English manual content,
• explicit A4 page planning as one framework across devices,
• large image allocation, page-overflow, and HTML verification,
• release checks for safe reuse and open-source publishing.

No customer photos, HMI screenshots, PDFs, feedback images, private paths, or project deliverables are bundled in this repository.

When To Use

Use this skill when a manual project involves:

• industrial or non-standard equipment,
• heat-transfer, hot-stamping, conveying, lifting, or fixture-changeover machinery,
• bilingual Chinese / English HTML output,
• HMI parameter pages that need behavior explanations,
• SFC, timing, sensor, or actuator sequence review,
• Chinese-only machine callouts that need English annotations,
• final A4-paged HTML verification, large page images, and token-efficient phase handoff.

Repository Contents

SKILL.md                              Main skill instructions
references/manual-builder-workflow.md Skill-internal workflow reference
references/hmi-parameter-explanation.md Integrated HMI/SFC parameter workflow
references/project-structure.md       Folder and naming contract
references/audit-checklist.md         Manual delivery audit checklist
references/html-only-delivery.md      HTML-only delivery boundary
references/a4-page-layout.md          Single A4 framework and image-share rules
references/rework-prevention.md       Rework and context-control guidance
templates/项目看板.md                  Project board template
templates/SFC时序审核稿.md             SFC review draft template
templates/交接摘要.md                  Compact phase handoff template
templates/A4分页规划.md                Semantic A4 page-map template
scripts/audit_manual_project.py       Audit a real manual project
scripts/check_release.py              Audit this repository before release
evals/evals.json                      Lightweight skill evaluation prompts

Install Locally

Copy this folder to your Codex skills directory:

%USERPROFILE%\.codex\skills\mg-industrial-equipment-manual-builder

Audit A Manual Project

python scripts/audit_manual_project.py "C:\path\to\manual-project"

Release Check

Before publishing or after changing repository files:

python scripts/check_release.py .
python -m json.tool evals/evals.json
python -m py_compile scripts/audit_manual_project.py scripts/check_release.py

Integrated Capabilities

• HMI parameter explanation is built into this skill through references/hmi-parameter-explanation.md.
• SFC/timing review, parameter confirmation tables, evidence discipline, and customer-ready bilingual parameter cards are handled inside this skill.
• Mechanism-based heat-transfer troubleshooting can still be informed by the user's shop-floor knowledge, but this skill no longer requires chaining a separate HMI parameter skill.

License

MIT. See LICENSE.