Be honest. When was the last time your custom application was fully documented and up to date?
If you’re like most companies, it has probably been awhile and for a very good reason. Business needs and the software applications that support them change constantly. Development time trumps paperwork. One software rev follows another, and pretty soon the application on the server and the documentation in the drawer are completely different.
It may be that the application was never fully documented in the first place or that the size and complexity of the application required so much documentation that even if you have it, your development team can’t use it effectively.
The challenge comes when a serious issue occurs or when a major application upgrade is looming. Then it may take days or weeks of new discovery to find the root of the problem, a waste of time and money that could have been prevented if the documentation was usable.
Never be Out of Date Again
When your challenge is out of date, complex or unusable documentation, LCS Technologies has the solution. The company’s Document Engine creates documentation in real time as the code is being written. When the code changes it is a simple routine to update the documentation to the latest version. This means that no matter how many times your software application changes, the documentation will always reflect the current code and business rules.
LCS’ Document Engine reduces the time and money needed for technical writers. It also enables a business analyst to do some of the work that normally requires expensive developer time. Another key benefit is the archival capability which is a document repository which allows for real time discovery of the information needed to validate application code and business rules.
How It Works
There are three components to the LCS Document Engine.
- Document Engine which provides the framework for developing documentation for each application.
- Custom module for each customer or environment. This is the piece that gathers the information needed to create the documentation.
- Information framework, LCS Technologies’ proprietary data formatting scheme for collecting and generating the information.
The documentation process begins with an agreement between our client and LCS as to what kind of documentation is required for the application. LCS then creates a custom module to retrieve, collect and store that information.
The Next Step
Future releases of the documentation engine will enable real-time search and indexing via interlinked Web pages so that they can be collaboratively used by multiple users within the corporation or community.
Maximize Your Resources
With LCS Document Engine, a business analyst (BA) can replace a technical writer and reduce developer time because the BA can input data directly into a format that the documentation engine understands so input becomes the output. This process also makes analysis easier. Instead of a programmer doing 100% of the work, a BA is able to enter the data in the system that feeds the application so a BA can do 50% of a developers work.
When out of date documentation is the problem, LCS Technologies has the solution─real-time documentation that saves time and money. That’s what Leading with Innovation is all about.