User:Nkchuank/sandbox

IVANDOC SYSTEM

IvanDoc System is an auto-generator of cross-referencing technical documentation on any application software  running in the IBM i / AS400  operating system. Even though the technical documentation is created and generated by programs in the IBM i / AS400 operating system, its various types of technical documents are assessed and viewed vide web browsers and are cross-referenced vide HTML hyperlinks.

First process: Scanning and data collection for the contents of documentation.
Firstly, being an auto-generator of technical documentation, IvanDoc System runs in the IBM i / AS400 operating system to scan all the objects of the business application to capture data from them. These object data are technical information about the architecture of the application software and are used by IvanDoc System to create and auto-generate various types of technical documents about the application software. Beside the objects, IvanDoc System can scan the source code of the application software to auto-generate and produce more types of technical documents.

Second process: Construction of technical documents with insertion of HTML hyperlinks.
The capability to cross-reference from one location of a technical document to a particular location of another technical document or vice versa, is now made possible with the use of HTML hyperlinks if  the technical documents are written in HTML files or web pages.

IvanDoc System is a unique documentation generator that has been created to add this feature of cross-referencing vide HTML hyperlinks, into the technical documentation about any business application software running in the IBM i / AS400 operating system.

To provide meaningful cross-referencing among various types of technical documents, IvanDoc System has been engineered to insert HTML hyperlinks into the technical documents during their construction. These technical documents are actually static web pages, written by programs in IvanDoc System in HyperText Markup Language (HTML). However, at this point, these technical documents are not ready to be viewed vide web browsers as they are still residing in source physical files in the IBM i / AS400 operating system.

Third process: FTP transfer of technical documents to browser-based operating system.
Thirdly, IvanDoc System facilitates the FTP transfer of these documents from the IBM i / AS400 operating system to any popular browser-based operating system where they can be assessed and viewed vide web browsers. Because the number of these documents or HTML files is usually huge and to ensure that not a single document is missed, IvanDoc System has the mechanism to keep track of which documents have been successfully transferred and which have not.

All are economically repeatable.
As all the three main processes of IvanDoc System  are automated,  they can be economically repeated to update the technical documentation whenever it is out-dated by substantial changes which have been made to the application software.

IvanDoc Documentation
This unique technical documentation, having been created in the IBM i / AS400 operating system and whose contents originate from the IBM i / AS400 application software, but whose technical documents are able to be viewed only in browser-based operating system, where cross-referencing among the various types of technical documents can be achieved with the help of HTML hyperlinks, is called “IvanDoc Documentation”.

Unlike technical documentation in the IBM i / AS400 operating system where IBM 'green-screens', spooled files, object data stored in physical files and SEU / PDM are used, IvanDoc Documentation provides the IBM i / AS400 software developers, in search of the knowledge of the architecture of the application software, with the new experience of navigating through the technical documentation in browser-based environment, thanks to the HTML hyperlinks.

Toggle between IBM i/AS400 and browser sessions enables the IBM i / AS400 software developers to browse through IvanDoc Documentation while they are being logged in their IBM i/AS400 session.

Technical documents in IvanDoc Documentation
There are more than forty types of technical documents in IvanDoc Documentation. Each technical document of one type is linked to technical documents of other types by HTML hyperlinks. Each technical document is actually one HTML file and varies in size. Generally, the total number of technical documents or HTML files in IvanDoc Documentation depends on the size and complexity of the application software and the extent of the source code that has been scanned.

The various types of technical documents can be grouped into the following three categories based on the origin of their contents;


 * 1) Category (1) : Those whose contents originate from the object data only.
 * 2) Category (2) : Those whose contents originate from the source code only.
 * 3) Category (3) : Those whose contents originate from both the object data and the source code.