Writing Effective Documentation

Writing Effective Documentation >> Technical Support Fundamentals

1. Overview: Documentation is an important part of an IT Support Specialist role. It’s vital to document processes and policies not only for yourself but for your teammates that may encounter the same issue. This writing assessment will help you get in the habit of writing good documentation.

What You’ll Do: For this writing project, you will write documentation to explain the process of making a peanut butter and jelly sandwich to someone who has never seen one before. You’ll want to be detailed yet concise. Specifically, the documentation should have:

1. A description of the problem.
2. A description of the end result.
3. The solution detailed in a step-by-step manner.

---

 

 

Making a peanut butter and jelly sandwich.

Problem Description: 
    Explain the process of making a peanut butter and jelly sandwich to someone who has never seen one before. 

Solutions:
    User want me to explain how to make a peanut butter and jelly sandwich. so i write to him following instructions:
    
    Step 1: Gather Your Ingredients for the Sandwich.
    Step 2: Put Gloves on (optional).
    Step 3: Pull Out Two Slices of Bread.
    Step 4: Open Peanut Butter and Jelly.
    Step 5: Spread the Peanut Butter Onto One Slice of Bread.
    Step 6: Spread the Jelly Onto the Other Slice of Bread.
    Step 7: Combine the Two Slices.
    Step 8: Cut Off the Crusts (optional). 
    Step 10: Clean Up Your Workspace. 
    Step 11: Enjoy Your Sandwich.

Reference: https://www.instructables.com/id/How-to-Make-a-Peanut-Butter-and-Jelly-Sandwich-4/