The original document was written by the SME, an engineer. I edited the document for ease of use and greater comprehension. The audience for these instructions is warehouse employees who may or may not have experience with the software described in the document. For this reason, the document begins at a general level, drilling down step by step, assuming no prior knowledge other than basic computing. I included visual cues when referring to the software. I omitted technical jargon. Additionally, I changed the instructions so they could be used on a Windows PC. (The users will be using Windows; the original author uses a Mac.) Note that I stripped out proprietary details. This sample is an excerpt, not the full document.
This is an internal Salesforce user guide, which I re-designed. The audience an internal Support team.
Summary of changes:
Summary of changes:
- It's been restructured to be task-based (e.g. creating a new case; updating an existing case) instead of a screen-by-screen explanation.
- A table of contents has been added.
- Warnings and explanations are visually separated from step-by-step instructions.
- It now uses the first person.
Manuals, installation guides, and other technical writing samples are available upon request.
Icon made by <a href="https://www.flaticon.com/authors/pixel-perfect" title="Pixel perfect">