Procedures and Checklists
Procedures and checklists provide the structure for doing business. They help your employees complete jobs safely and give your customers consistent service. They help new workers understand how to do the tasks that keep your company running and preserve the knowledge of your longstanding employees.
The subject matter experts who already know how to do a job can overlook important procedural details that really matter to new users. It's difficult for technical experts to step through a procedure from the user's perspective. They might assume that everyone understands the jargon associated with a task or use different words to mean the same tool. Sometimes, they skip steps or details that seem too minor to write down. Problems like these can destroy the usefulness of procedures and checklists, which must be clear, complete, easy to understand, and consistent.
I can work from interviews, existing documents, notes, and outlines to write and edit your procedures and checklists, including:
- Clarifying meaning, eliminating jargon, and simplifying text.
- Finding gaps and missing information.
- Applying a consistent voice throughout the procedure.
- Improving document organization and reduce information clutter.
- Checking spelling, grammar, and sentence construction.
- Using clean, attractive formatting that makes procedures and checklists easier to read.
I can review your existing procedures and checklists, work with subject matter experts to identify the documentation you really need, recommend tools and formats that will work well for your users, and develop a maintenance strategy that will keep your procedures and checklists up-to-date.
Technical documentation does not have to be a black hole of lost time and tedious dicussion. We can start with what you have and improve from there.