Technical Documentation

Industry Experience

Many insurance companies are running large mainframe applications like IMS, DB2, IDMS, SQL Server, VSAM, CICS and lots of SQL.
We have the experience in these applications and the peripheral JCL and DASD operations.

At the same time, our documentation efforts are stellar and the illustrations are as well.

Our DYL280 and Easytrieve expertise can cut development of new modules to a fraction of the time. See our Database Design for even more detailed experience..

Technical Documentation


HELP Diagram

Document creation can take many different forms and in some cases take on a life of their own. Experience has shown us that a ‘one size fits all’ approach is not always applicable so our process follows a typical example of the document creation cycle.When there are no existing documents, we start from the beginning and formulate a baseline for creation.These are the basic steps:

Requirements Definition:

Determine the type of documentation required and the best style and format.

  • Policy and Procedure
  • 'How To' Manual
  • Functional Specification
  • Technical Specification
  • User Guide
  • Program Specification
  • System Specification
  • White Paper
  • Newsletter
  • Brochure
  • Presentation
  • Data Gathering:
    Conduct interviews of SMEs where necessary and compile operational notes. Organize and create a working text for review.
    For an illustrated example of our documentation approach,
  • Illustrations and diagrams:
    Complex concepts and system depictions can be visually narrated with the use of such tools as:
    • Visio
    • Illustrator
    • Photoshop
    • Fireworks
    • Powerpoint
  • Review Process:
    Electronic routing is a proven method for facilitating the review and feedback of all concerned parties.
  • Sign-off
  • Users should be involved in every phase of the process to ensure signoff.

About Us | Site Map | Privacy Policy | Contact Us | ©2009 Intechs.com