[Framers] What causes documentation to fail

[John Sgammato]

And there's the Miracle of Compound Interest - every time you add a new
title, you then have to maintain it from version to version, so the
workload grows even if the department doesn't.

On Fri, May 20, 2016 at 1:27 PM, Catherine Woods <catwood55 at gmail.com>
wrote:

> Documentation creep - like every 4 months project management "thinks" up
> another document (or decides that original docs should be split into x) and
> expects the one assigned writer to pick it up
> Buy-in from project management on the documentation to be written that
> "don't change over time"
> Mysterious end-customer requirements - an end-customer that can dictate the
> documentation
>
> I speak from experience on documentation failure.
> Catherine
>
> On Fri, May 20, 2016 at 9:48 AM, <john.x.posada at us.hsbc.com> wrote:
>
> >
> > 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 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




-- 

<http://www.actifio.com/>        *John Sgammato, Documentation Architect*
*e* john.sgammato at actifio.com  *c* 508.927.2083
*t* @actifiodocs <http://twitter.com/actifiodocs>

333 Wyman Street, Waltham, MA 02451
<http://twitter.com/actifio>    <http://www.linkedin.com/company/399246>
<https://plus.google.com/102870897962348937868/posts>
<http://www.youtube.com/user/actifio>    <http://www.actifio.com/>

*Manage, access, and protect your data with a single platform that saves
you time, money, and complexity.*