« What's All this Governance Stuff About and How Does It Affect Me? (Part 1) | Main| What is all this Governance stuff about and how does it affect me (Part 2) »

Application Documentation

Welcome guest blogger, Eileen Fitzgerald!

I’m sure many of you already know Eileen Fitzgerald. For those of you who don’t, she has been very involved in the Lotus Notes community for more than 12 years, and has been very involved with the Irish Local Users’ Group (ILUG). To learn more about Eileen, visit her LinkedIn profile.

Eileen has been involved with implementing ITIL at Lease Plan Corporation I am very happy to welcome Eileen as a guest blogger on Teamstudio’s governance blog.

Scott Johnsen

Application Documentation

Application documentation, how much is too little, too much and how much is just enough. When documenting applications, you normally require the documentation for some primary reasons such as:

  • Compliance
  • Knowledge Sharing
  • Change Control
  • Reference
  • Risk Management

read more
But how much is enough and when do you get to the point where you are simply documenting for the sake of documenting? Over documenting is all an extreme waste of time and money adding no value to the company. It’s difficult but you need to find the balance between business, technical and compliance requirements.

First thing to do is identify the type of documents that are required to support your application. It is divided into Master documents (updated with releases) and Release documents specific to each release. Once you are in agreement with the types of documents that need to be in your application suite, we can look at what content needs to be in each document. I'm going to throw out a list of the types of documents your application suite should consist of. Let me know what you think.

Application Master Documents
  1. Security Document (Security management levels on the application.)
  2. System Design (System architecture.)
  3. Maintenance (Maintenance tasks associated with managing the application.)
  4. Operational (Day-to-day operational activities that the application performs, agents, data transfers, etc.)
  5. Version Management (How versions are managed in the application)
  6. User Manual

Release Documents
  1. Functional Changes
  2. Test Plan and Test Scripts
  3. Release Notes

Category   

Comments

1 - can you share some example documents so we can compare our current documents with them?

2 - Hi Patrick,

At the moment I'll be looking at the types of documents and basic content that is required per document vs actually posting templates.

I'd be interested in hearing what types of documents that you have accompanying your applicaitons if you would care to share that ?


Eileen

Post A Comment

Feeds

Custom Button Custom Button

Category Cloud

Disclaimer

The views expressed by the authors on this blog do not necessarily reflect the views of Teamstudio, those who link to this blog, or even the author’s mother, father, sister, brother, uncle, aunt, grandparents, cousins, step relations, any other blood relative - and sometimes not even the author himself or herself.

Comments on this website are the sole responsibility of their writers and it is assumed those writers will take full responsibility, liability, and blame for any libel or litigation that results from something written in, or as a direct result of something written in, a comment. The accuracy, completeness, veracity, honesty, exactitude, factuality and politeness of comments are not guaranteed. Oh, how they are SO not guaranteed.
en-us,en;q=0.5OFFCCBot/1.0 (+http://www.commoncrawl.org/bot.html)38.107.179.214www.getthemostfromnotes.comHTTP/1.180Lotus-Domino/tsblog.nsf/d6plinks/TBAN-7MEQPU-Application_Documentation