The ASP Documentation Tool™ Application

Click image for full sized version

Click image for full sized version

The ASP Documentation Tool™ uses a graphical user interface to edit the ASP Documentation Tool™'s configuration options without needing to manually edit .bat files. The ASP Documentation Tool™ can be run by clicking on the Run This Task button and output displayed using the View Output buttton.

The ASP Documentation Tool™ application displays a status report in a command prompt window. A detailed report of the applications activity is also saved to a log file [view sample log file].

The ASP Documentation Tool™ can be scheduled to update project documentation using the Scheduled Tasks feature of Windows.

The ASP Documentation Tool™ Reports

The ASP Documentation Tool™'s reports are created in standard HTML format which can be viewed in most web browsers, including Internet Explorer, Netscape and Firefox. They may be optionally formatted using a Cascading Style Sheet (CSS) file of your own choosing.

View a sample report in standard HTML format.

The ASP Documentation Tool™ can also create reports in Microsoft's HTML Help format. This is the same format that most Windows applications use for their own help documentation. HTML Help compiles HTML files into a single compressed .chm file. The HTML pages are accessible from a heirarchical table of contents. The HTML Help report is fully searchable (including the ASP source code and text of SQL Server stored procedures). All entities found in the project are contained in the index.

View a sample report in Microsoft's HTML Help format.

There is also an option for creating the ASP Documentation Tool™'s reports in plain text format. This text file can of course be opened in any text editor or Word processor, and can form the basis of a web application's technical documentation.

View a sample report in text format.