System Manual¶
Overview¶
This folder contains the user-facing system manual for the current application. It is intended for internal users, new hires, trainers, support staff, developers, and AI systems that need a task-oriented reference for how the product works today.
Manual Structure¶
- Application Manual: full end-user system manual
- Role Guides: role-based training paths
- Workflow Guides: task-based procedures
- Screenshot Guide: how to capture and embed screenshots
- Assets README: where image files should live
Recommended Reading Order¶
- Application Manual
- Role guide for the user’s job
- Workflow guide for the exact task being trained
- Screenshot guide when preparing training content or manuals
Maintenance Rule¶
Update the workflow guide first when product behavior changes. Then update any role guides or screenshots that depend on that workflow.