[Framers] What causes documentation to fail

Etzel, Gary gary.etzel at dnvgl.com
Fri May 20 11:16:46 PDT 2016


I think you should pose the question as "What causes documentation to succeed?" Present the issue in a positive light, not a negative one. For example:

- Employing trained, dedicated technical communicators.
- Involving technical documentation from the first day of the project.
- Clearly defining roles, responsibilities, and scope.

And so on.

Gary


-----Original Message-----
From: Framers [mailto:framers-bounces+gary.etzel=dnvgl.com at lists.frameusers.com] On Behalf Of john.x.posada at us.hsbc.com
Sent: Friday, May 20, 2016 12:49 PM
To: framers at lists.frameusers.com
Subject: [Framers] What causes documentation to fail


Hi, guys...by end of today, I need to present to my manager a few bullet points for a presentation she is doing on Monday.

The subject is: "What Causes Documentation to Fail"

I've started with a few points:

   Not writing to a well-understood target audience
   Including too little or too much information
   Failure to bring documentation into the project early enough in the
   project
   Failure to establish a governance, review, and approval structure
   Lack of clear  roles and responsibilities
   Belief that “anyone can produce acceptable documentation”
   Lack of feedback early enough in the process to implement without
   wasting a large amount of work and/or affecting deadline
   Scope creep

Anyone want to add more to the list?


John X Posada
SR AML Syst & Ops Supt Data Analyst | Global Risk Analytics | HSBC North America Holdings Inc
330 Madison Ave., NY NY

 __________________________________________________________________





 Phone
      Int: 212-525-5483 Ext: 646-735-1857
 Fax
      Conference Bridge - 877-304-0052, Code 74809254
 Email
      john.x.posada at us.hsbc.com

 __________________________________________________________________
 Protect our environment - please only print this if you have to!



-----------------------------------------
******************************************************************
This E-mail is confidential. It may also be legally privileged. If you are not the addressee you may not copy, forward, disclose or use any part of it. If you have received this message in error, please delete it and all copies from your system and notify the sender immediately by return E-mail.

Internet communications cannot be guaranteed to be timely, secure, error or virus-free. The sender does not accept liability for any errors or omissions.
******************************************************************
SAVE PAPER - THINK BEFORE YOU PRINT!
_______________________________________________

This message is from the Framers mailing list

Send messages to framers at lists.frameusers.com Visit the list's homepage at  http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/
Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
Send administrative questions to listadmin at frameusers.com

**************************************************************************************
This e-mail and any attachments thereto may contain confidential information and/or information protected by intellectual property rights for the exclusive attention of the intended addressees named above. If you have received this transmission in error, please immediately notify the sender by return e-mail and delete this message and its attachments. Unauthorized use, copying or further full or partial distribution of this e-mail or its contents is prohibited.
**************************************************************************************


More information about the Framers mailing list