Summary: A complex process heavy in tribal knowledge and traditionally taught straight through, now formalized in a 40-page document that simultaneously serves as a technical manual and a training program. Customers have a wide variety of available options that all fall under this product, so this single guide has to account for every configuration in a way that doesn't overwhelm the trainee. The page also combines documentation of several individual processes, re-written for new hires rather than veterans.
Note: I do not design these processes, though I do collaborate with our process lead throughout R&D.
Outcome: Standardized terminology, build progression, and the individual processes within a [Product B] across the shop. Trainers can now maintain production while training due to the presence of robust visual aids, rather than focusing entirely on demonstration for a single new hire.
Targeted multiple audiences via scaffolding:
Cheat Sheet, for mid-build reference by experts who may primarily focus on other controller models.
Quick Reference, for partially trained techs that still need a step-by-step guide mid-build, with a small amount of context only.
Full Reference, a complete, standalone training program meant for use alongside a direct trainer. It contains deep explanations and context for every aspect of the process.
Ensured that, despite the document's density, visual aids support the entire build process when working alongside a trainer, without requiring close reading mid-build.
Full page contains 87 images, 9 videos, and 7 gifs.
Designed to promote conceptual understanding of the processes that could transfer to other controller models to reduce future training time.
Used existing Wiki tools and developed templates to better highlight important information:
Tabbers to better separate split-path variants, reduce scrolling burden, and reduce the risk of technicians reading the wrong instructions for the order configuration.
Callout boxes with unique colors, each used for a specific purpose.
Collapsible sections to hide information accessed less frequently.
Note: over the course of my time in this role, I've written versions of this guide for three major board revisions. This particular page, written for the most recent board revision, has gone through two total rewrites due to new process introductions and large process overhauls.
The full documentation contains proprietary processes that are under NDA. For this case study, I've included three partially redacted screenshots in the slideshow below that show my approach without revealing protected information.