{"id":64,"date":"2019-05-31T23:14:17","date_gmt":"2019-06-01T03:14:17","guid":{"rendered":"https:\/\/openstudio.pub\/techwriting\/chapter\/project-completion-documenting-work-completed\/"},"modified":"2025-04-14T08:08:00","modified_gmt":"2025-04-14T12:08:00","slug":"project-completion-documenting-work-completed","status":"publish","type":"chapter","link":"https:\/\/openstudio.pub\/techwriting\/chapter\/project-completion-documenting-work-completed\/","title":{"raw":"Project Completion\/Documenting Work Completed","rendered":"Project Completion\/Documenting Work Completed"},"content":{"raw":"
\n\nWhat is it? <\/strong>Documentation is an important part of almost every workplace. Good documentation can do the following:<\/span>\n\n<\/div>\n
    \n \t
  • Provide information for customers<\/li>\n \t
  • Provide information for upcoming shifts \/ other employees<\/li>\n \t
  • Avoid duplication of work<\/li>\n \t
  • Satisfy regulator bodies (warranties, state agencies etc.)<\/li>\n \t
  • Satisfy employers<\/li>\n<\/ul>\nWhy is it important? <\/strong>A person who documents their work appropriately appears professional to customers, coworkers, and employers. Good documentation shows that you have done good work.\n\nHow long should it be? <\/strong>Provide enough information for both a technician and a customer to understand what you've done, but don't include too much information or any unnecessary information, as this could potentially confuse the customer.\n\nEXAMPLES<\/strong>:\n

    Too short<\/strong>:\u00a0I fixed the problem.<\/p>\n

    Too Long<\/strong>:\u00a0First I turned the car on. Then I listened for sounds. I drove the car around the block approximately four time. I heard a knocking sound on the right side. I opened the hood\u2026etc.<\/p>\n

    Good length<\/strong>: After a thorough road test, I heard a knocking sound coming from the right side of the front end.\u00a0 Following a thorough garage inspection, I identified the problem as a damaged CV joint.<\/p>\nAudience<\/strong>\n

      \n \t
    • Provide enough information that future technicians will know what you did<\/li>\n \t
    • Provide enough information that customer service representatives or other technicians will be able to explain your work to customers<\/li>\n \t
    • Your write-up does not have to be crystal clear to a totally nontechnical audience (i.e., a customer who knows nothing about your profession), but it can't hurt to make it understandable to any reader.<\/li>\n<\/ul>","rendered":"
      \n

      What is it? <\/strong>Documentation is an important part of almost every workplace. Good documentation can do the following:<\/span><\/p>\n<\/div>\n

        \n
      • Provide information for customers<\/li>\n
      • Provide information for upcoming shifts \/ other employees<\/li>\n
      • Avoid duplication of work<\/li>\n
      • Satisfy regulator bodies (warranties, state agencies etc.)<\/li>\n
      • Satisfy employers<\/li>\n<\/ul>\n

        Why is it important? <\/strong>A person who documents their work appropriately appears professional to customers, coworkers, and employers. Good documentation shows that you have done good work.<\/p>\n

        How long should it be? <\/strong>Provide enough information for both a technician and a customer to understand what you’ve done, but don’t include too much information or any unnecessary information, as this could potentially confuse the customer.<\/p>\n

        EXAMPLES<\/strong>:<\/p>\n

        Too short<\/strong>:\u00a0I fixed the problem.<\/p>\n

        Too Long<\/strong>:\u00a0First I turned the car on. Then I listened for sounds. I drove the car around the block approximately four time. I heard a knocking sound on the right side. I opened the hood\u2026etc.<\/p>\n

        Good length<\/strong>: After a thorough road test, I heard a knocking sound coming from the right side of the front end.\u00a0 Following a thorough garage inspection, I identified the problem as a damaged CV joint.<\/p>\n

        Audience<\/strong><\/p>\n

          \n
        • Provide enough information that future technicians will know what you did<\/li>\n
        • Provide enough information that customer service representatives or other technicians will be able to explain your work to customers<\/li>\n
        • Your write-up does not have to be crystal clear to a totally nontechnical audience (i.e., a customer who knows nothing about your profession), but it can’t hurt to make it understandable to any reader.<\/li>\n<\/ul>\n","protected":false},"author":1,"menu_order":1,"template":"","meta":{"pb_show_title":"","pb_short_title":"","pb_subtitle":"","pb_authors":[],"pb_section_license":""},"chapter-type":[49],"contributor":[],"license":[],"class_list":["post-64","chapter","type-chapter","status-publish","hentry","chapter-type-numberless"],"part":63,"_links":{"self":[{"href":"https:\/\/openstudio.pub\/techwriting\/wp-json\/pressbooks\/v2\/chapters\/64","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/openstudio.pub\/techwriting\/wp-json\/pressbooks\/v2\/chapters"}],"about":[{"href":"https:\/\/openstudio.pub\/techwriting\/wp-json\/wp\/v2\/types\/chapter"}],"author":[{"embeddable":true,"href":"https:\/\/openstudio.pub\/techwriting\/wp-json\/wp\/v2\/users\/1"}],"version-history":[{"count":1,"href":"https:\/\/openstudio.pub\/techwriting\/wp-json\/pressbooks\/v2\/chapters\/64\/revisions"}],"predecessor-version":[{"id":65,"href":"https:\/\/openstudio.pub\/techwriting\/wp-json\/pressbooks\/v2\/chapters\/64\/revisions\/65"}],"part":[{"href":"https:\/\/openstudio.pub\/techwriting\/wp-json\/pressbooks\/v2\/parts\/63"}],"metadata":[{"href":"https:\/\/openstudio.pub\/techwriting\/wp-json\/pressbooks\/v2\/chapters\/64\/metadata\/"}],"wp:attachment":[{"href":"https:\/\/openstudio.pub\/techwriting\/wp-json\/wp\/v2\/media?parent=64"}],"wp:term":[{"taxonomy":"chapter-type","embeddable":true,"href":"https:\/\/openstudio.pub\/techwriting\/wp-json\/pressbooks\/v2\/chapter-type?post=64"},{"taxonomy":"contributor","embeddable":true,"href":"https:\/\/openstudio.pub\/techwriting\/wp-json\/wp\/v2\/contributor?post=64"},{"taxonomy":"license","embeddable":true,"href":"https:\/\/openstudio.pub\/techwriting\/wp-json\/wp\/v2\/license?post=64"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}