Archive for the ‘Documentation’ Category

Document Choreography of an EDI Purchase

 Document Choreography of an EDI Purchase

(more…)

Wednesday, February 10th, 2010

Architecture of an Integration

 Architecture of an Integration

Wednesday, February 3rd, 2010

Keep a personal copy of all documentation you create.

buddha clip art 150x150 Keep a personal copy of all documentation you create.Keeping a copy of all of the documentation you create is a pretty general benifit.  It helps you in three major ways;

  1. Having a personal copy means that if the systems that have the public copies become unavilable, you will still have access to them.
  2. Some times projects that get shelved, lose their documentation.  If you have a personal copy, when the project comes back to life, you will not be starting over.
  3. And you never know what future project you will be working on that will spark the memory, “Hey we solved a problem like this on this other project…”  And having the documentation for it will help you.

I have never regretted keeping a personal copy of documentation.  But I have always regretted knowing that I didn’t keep one when I could have used it.

Monday, January 18th, 2010

Keep your Documentation Organized.

vault pzl Keep your Documentation Organized.One of the things that I advocate is keeping a copy of the documentation you produce, and the documentation that you encounter and use.  Over a short period of time, this can become a large amount of stuff.  If you are just throwing it all in your MyDocuments folder, it can quickly get out of hand.  To help out in this ongoing task and fight against the chaos, I am going to share some basic approaches that can help keep the sanity and utility in your documentation collection. (more…)

Tuesday, October 13th, 2009

10 tips on making effective documentation

Stack of DocumentsOne of the things that Integration Engineers are asked to do is create documentation.  But as we all know, many times documentation is the last and poorest part of a project.  Developers and programmers don’t generally like writing documentation, and are generally considered the most qualified.

In comes the Integration Engineer to make the system work.  Producing effective documentation at this point is important.  We want to make the system work, and then hand if off to the team that will support it.  If we don’t create effective documentation, this last step can never happen, and we will be unable to undertake new integration work because we are still supporting the first one.  And if we are a contractor, we need this even more. (more…)

Monday, May 11th, 2009