SlideShare a Scribd company logo
1 of 24
Written Communications and the Engineer


                           October 23, 2012
                        Marina Pratchett QC
             Fasken Martineau DuMoulin LLP
TECHNICAL WRITING
 Specifications
 Reports: expert, design, progress, laboratory
 Investigations
 Analysis
 Proposals
 Instructions
 Papers
TECHNICAL WRITING
 Produce Literature
 User Manuals
 Reference Manuals
 Policy and Procedure Guides
 Requests for Tender or Requests for
 Proposals
Technical Writing
 Engineers are Information Specialists
 Learned skill
 Encourage firms to build in courses in
 formal training program
 Discrete Discipline
 In IT circles: Subject Matter Experts
 (SME)
 Courses and Books
Technical Writing

 Why is a lawyer commenting on
 Technical Writing???
 What is more important ..written or oral
 communication skills
Technical Writing
 This is NOT a “how to” lecture
 Identification of a purpose and intended
 audience
   Often lost or not evident on reading
   Purpose may dictated tone, format and
   content:
      who will be relying on and for what purpose
     What use might be made of the document in
     the future
Technical Writing

   Focusing on the subject matter
Technical Writing

   Format, flow and structure
Technical Writing

   Observe formality
Technical Writing

   Logical Sequence and Organization
Technical Writing

   Factual, accurate, objective
Technical Writing

   Time line to write
Technical Writing

   Two Examples
     Specifications
     Forensic Expert Reports
Technical Writing


   Specifications
     Rely on precedents without understanding
     content and intended application
     Ambiguous
     Redundancies
     Inconsistencies
     Prolix
Technical Writing


   Specifications
     Engineers can be sued in negligence for
     drafting errors
Technical Writing


   Specifications
     Throwing legal language into specification
Technical Writing

   Expert Reports for Court
     Very expensive to find out engineer cannot
     write the necessary report
     Only option is not to use report
     Report has to follow certain guidelines
     Report has to stand alone as a complete
     document and be understood by Judge
     Report has to include all assumed facts
     Engineers working papers will be produced
Technical Writing

 Without Prejudice Communications
   Labeling it does not make it so
   Marking it ‘Confidential” does not protect it
   from disclosure in an action
   Communications between solicitor and
   client
   Communications for purpose of settling a
   dispute
Technical Writing

 Without Prejudice Communications
   When contemplating litigation,
   communication with experts often goes
   through legal counsel to preserve or
   protect privilege
   But privilege can be waived – possibly
   inadvertently
Technical Writing
 Without Prejudice Communications
   When you participate in a meeting with
   legal counsel or you provide documents for
   legal counsel, mark them Privileged,
   Prepared for/in anticipation of Litigation
   Communicate only with legal counsel –
   don’t copy the client. Let legal do that.
   Records of meetings or discussions with
   legal counsel – mark them clearly –
   suggest writing in red
Technical Writing

 Record Keeping Generally
 Loss Control Procedures 101
   Write it down, keep records
   Accurate, complete and made at the time
   Don’t fabricate, back-date or alter, no
   matter how tempting
   Records belong to your company
   Follow any corporate record keeping
   protocols
Technical Writing

 Record Keeping Generally
 Loss Control Procedures 101
   Keep record factual
   Should have a policy and procedure for
   dealing with email communications
   Assume someone else will be looking at
   your file and communications
Technical Writing

 Record Keeping Generally
 Loss Control Procedures 101
   Think about what would happen if you left
   the firm suddenly and someone else had to
   step in
Technical Writing

 Questions

More Related Content

Similar to Dm van #8449731-v1-technical-writing_for_engineers

Introduction to Technical Writing - Priti Gaikwad
Introduction to Technical Writing - Priti GaikwadIntroduction to Technical Writing - Priti Gaikwad
Introduction to Technical Writing - Priti GaikwadPriti Gaikwad
 
Computer aided technical communication
Computer aided technical communicationComputer aided technical communication
Computer aided technical communicationRashmi Joshi
 
Computer aided technical communication
Computer aided technical communicationComputer aided technical communication
Computer aided technical communicationRashmi Joshi
 
Registered professional titles presentation
Registered professional titles presentationRegistered professional titles presentation
Registered professional titles presentationRoseanne O'Leary
 
Technical writing hw5
Technical writing hw5Technical writing hw5
Technical writing hw5Kaoru Morito
 
Forms of technical_communication
Forms of technical_communicationForms of technical_communication
Forms of technical_communicationBishnu Shrestha
 
Business-Analyst_Deepthy
Business-Analyst_DeepthyBusiness-Analyst_Deepthy
Business-Analyst_DeepthyDeepthy KS
 
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docx
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docxTechnical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docx
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docxjacqueliner9
 
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docx
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docxTechnical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docx
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docxSANSKAR20
 
Technical Comms Process Nf
Technical Comms Process NfTechnical Comms Process Nf
Technical Comms Process NfJohn_Wilson
 
Technical Report Writing Presentation
Technical Report Writing PresentationTechnical Report Writing Presentation
Technical Report Writing PresentationMilki Feyissa Lemma
 
Documentation Best Practices for EAPs
Documentation Best Practices for EAPsDocumentation Best Practices for EAPs
Documentation Best Practices for EAPsCG Hylton Inc.
 
Keeping up with technology evolving your it leadership knowledge and capabi...
Keeping up with technology   evolving your it leadership knowledge and capabi...Keeping up with technology   evolving your it leadership knowledge and capabi...
Keeping up with technology evolving your it leadership knowledge and capabi...David Cunningham
 
IT Business Analyst Job Description, Salary, and Roles (1).pdf
IT Business Analyst Job Description, Salary, and Roles (1).pdfIT Business Analyst Job Description, Salary, and Roles (1).pdf
IT Business Analyst Job Description, Salary, and Roles (1).pdfeducationedge.ca
 
Audience recognition and knowledge of subject matter
Audience recognition and knowledge of subject matterAudience recognition and knowledge of subject matter
Audience recognition and knowledge of subject mattertayyabhasnainkhan
 

Similar to Dm van #8449731-v1-technical-writing_for_engineers (20)

Azam baloch
Azam balochAzam baloch
Azam baloch
 
Introduction to Technical Writing - Priti Gaikwad
Introduction to Technical Writing - Priti GaikwadIntroduction to Technical Writing - Priti Gaikwad
Introduction to Technical Writing - Priti Gaikwad
 
Presentation5
Presentation5Presentation5
Presentation5
 
Computer aided technical communication
Computer aided technical communicationComputer aided technical communication
Computer aided technical communication
 
Computer aided technical communication
Computer aided technical communicationComputer aided technical communication
Computer aided technical communication
 
Presentation5
Presentation5Presentation5
Presentation5
 
Registered professional titles presentation
Registered professional titles presentationRegistered professional titles presentation
Registered professional titles presentation
 
Technical writing hw5
Technical writing hw5Technical writing hw5
Technical writing hw5
 
Forms of technical_communication
Forms of technical_communicationForms of technical_communication
Forms of technical_communication
 
Business-Analyst_Deepthy
Business-Analyst_DeepthyBusiness-Analyst_Deepthy
Business-Analyst_Deepthy
 
What is Data Capture
What is Data CaptureWhat is Data Capture
What is Data Capture
 
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docx
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docxTechnical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docx
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docx
 
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docx
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docxTechnical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docx
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docx
 
Technical Comms Process Nf
Technical Comms Process NfTechnical Comms Process Nf
Technical Comms Process Nf
 
Technical Report Writing Presentation
Technical Report Writing PresentationTechnical Report Writing Presentation
Technical Report Writing Presentation
 
Documentation Best Practices for EAPs
Documentation Best Practices for EAPsDocumentation Best Practices for EAPs
Documentation Best Practices for EAPs
 
Keeping up with technology evolving your it leadership knowledge and capabi...
Keeping up with technology   evolving your it leadership knowledge and capabi...Keeping up with technology   evolving your it leadership knowledge and capabi...
Keeping up with technology evolving your it leadership knowledge and capabi...
 
IT Business Analyst Job Description, Salary, and Roles (1).pdf
IT Business Analyst Job Description, Salary, and Roles (1).pdfIT Business Analyst Job Description, Salary, and Roles (1).pdf
IT Business Analyst Job Description, Salary, and Roles (1).pdf
 
Audience types
Audience typesAudience types
Audience types
 
Audience recognition and knowledge of subject matter
Audience recognition and knowledge of subject matterAudience recognition and knowledge of subject matter
Audience recognition and knowledge of subject matter
 

Dm van #8449731-v1-technical-writing_for_engineers

  • 1. Written Communications and the Engineer October 23, 2012 Marina Pratchett QC Fasken Martineau DuMoulin LLP
  • 2. TECHNICAL WRITING Specifications Reports: expert, design, progress, laboratory Investigations Analysis Proposals Instructions Papers
  • 3. TECHNICAL WRITING Produce Literature User Manuals Reference Manuals Policy and Procedure Guides Requests for Tender or Requests for Proposals
  • 4. Technical Writing Engineers are Information Specialists Learned skill Encourage firms to build in courses in formal training program Discrete Discipline In IT circles: Subject Matter Experts (SME) Courses and Books
  • 5. Technical Writing Why is a lawyer commenting on Technical Writing??? What is more important ..written or oral communication skills
  • 6. Technical Writing This is NOT a “how to” lecture Identification of a purpose and intended audience Often lost or not evident on reading Purpose may dictated tone, format and content: who will be relying on and for what purpose What use might be made of the document in the future
  • 7. Technical Writing Focusing on the subject matter
  • 8. Technical Writing Format, flow and structure
  • 9. Technical Writing Observe formality
  • 10. Technical Writing Logical Sequence and Organization
  • 11. Technical Writing Factual, accurate, objective
  • 12. Technical Writing Time line to write
  • 13. Technical Writing Two Examples Specifications Forensic Expert Reports
  • 14. Technical Writing Specifications Rely on precedents without understanding content and intended application Ambiguous Redundancies Inconsistencies Prolix
  • 15. Technical Writing Specifications Engineers can be sued in negligence for drafting errors
  • 16. Technical Writing Specifications Throwing legal language into specification
  • 17. Technical Writing Expert Reports for Court Very expensive to find out engineer cannot write the necessary report Only option is not to use report Report has to follow certain guidelines Report has to stand alone as a complete document and be understood by Judge Report has to include all assumed facts Engineers working papers will be produced
  • 18. Technical Writing Without Prejudice Communications Labeling it does not make it so Marking it ‘Confidential” does not protect it from disclosure in an action Communications between solicitor and client Communications for purpose of settling a dispute
  • 19. Technical Writing Without Prejudice Communications When contemplating litigation, communication with experts often goes through legal counsel to preserve or protect privilege But privilege can be waived – possibly inadvertently
  • 20. Technical Writing Without Prejudice Communications When you participate in a meeting with legal counsel or you provide documents for legal counsel, mark them Privileged, Prepared for/in anticipation of Litigation Communicate only with legal counsel – don’t copy the client. Let legal do that. Records of meetings or discussions with legal counsel – mark them clearly – suggest writing in red
  • 21. Technical Writing Record Keeping Generally Loss Control Procedures 101 Write it down, keep records Accurate, complete and made at the time Don’t fabricate, back-date or alter, no matter how tempting Records belong to your company Follow any corporate record keeping protocols
  • 22. Technical Writing Record Keeping Generally Loss Control Procedures 101 Keep record factual Should have a policy and procedure for dealing with email communications Assume someone else will be looking at your file and communications
  • 23. Technical Writing Record Keeping Generally Loss Control Procedures 101 Think about what would happen if you left the firm suddenly and someone else had to step in