Documentation

Unfortunately, technical documentation, all too often given lower priority in development projects. Typically this is due to compressed timelines or just a general downgrading rather than to solve specific tasks - "... We'll do that when we finished the development ...".

The technical documentation is the basis for that at all times to maintain or extend the application in a proper manner. Also binds the technical skills not some key people who eventually become so indispensable to the company. Often we find companies where one employee has resigned and you are left with a half-or full pre-application where other developers are entering to take over. Situations like this usually ends with the fact that it would be more appropriate to rewrite parts (or all) of the application is to find the "head and tail" of the existing. The end result is a lot of lost work and technical knowledge has been lost or must be acquired again by new developers.

There is no doubt that the evidence at the forefront is the solution to most problems. In practice it is far from what is happening.

With our long experience in development, we go in and analyze the applications and prepare a technical documentation that enables the company to maintain, extend or debug applications.

The evidence we draw is in the form of textual documentation, diagramming in the form of UML (package, class, sequence diagrams) and any documentation in source code level (traditional and nDoc based).

During the documentation of applications, we encounter typical program constructs which can range from inconvenient to potentially dangerous to the program flow or future expansions. These discoveries are part of our documentation together with a recommendation on how the problem areas might be alleviated or avoided. Preparation of technical documentation, manuals, localization, online help, e-learning and the like. are also areas we would like to assist with.

Please contact us for further information.