Living Doc automates the arduous documentation process developers regularly come across. Living Doc documents the individual building blocks of your web applications while showing the relationships between them.
With the documentation Living Doc produces you can easily see what stored procedures an ASP page calls or what tables those same procedures call, and much more! If you need to modify your applications, Living Doc delivers the means to quickly find out which objects need to be updated.
One of the really cool features of Living Doc is how the documentation is presented. Every "nugget"
of information about your project is hyperlinked. Click on an ASP page and you see which stored procedures
and tables it uses (among other things). Click on one of those procedures and you see the
detailed information about that procedure, for example which tables it uses. Click on one of the
tables listed and you'll be shown a page with the documentation for that table. And so on...
Doing a documentation scan is a breeze...
No learning curve for new programmers
This hyperlinked approach makes it very easy for programmers to get familiar with a project. Living
Doc is the perfect tool for maintaining existing projects. It also makes it easy to answer all the
what-if-questions that can arise if you, for example, plan to add a column to a table. By using Living Doc
you can easily see which stored procedures, COM objects, and ASP pages will be affected when adding a column to a table.
It is easy to see what has changed between two snapshots.
Living Doc lets you take what we call "snapshots" of your project. A snapshot is a complete documentation scan at a specific point in time.
You can take snapshots of your project as often as you want. One tip is to add the Living Doc scanner
to the Scheduled Tasks. This makes it possible for the system to automatically take a snapshot
each day or once a week.
You can compare two snapshots with each other and see what has changed in the project between the
two snapshots. Perfect for error handling ("we know the project was working fine at snapshot X, let's compare
that with the current snapshot").
You can select which two snapshots you want to compare.
All source code is saved
For each snapshot all source is stored in the documentation database. And we are not just talking about
ASP source code, the source for your stored procedures is saved, as is the code for your COM objects. However, we want to
point out that Living Doc is not a source code version control tool that supports checking in and out source code.
During every scan, all source code for ASP pages, stored procedures et cetera is saved in the documentation database.
Create MS Word document
Living Doc can create a comprehensive MS Word document to easily print your documentation.
General project information
Number of ASP pages
ASP server name
Database server name
Number of tables
Stored procedure count
OS on the db server
Memory on the db server
For ASP pages
Stored procedures called
COM object called
File- and folder names
Updated/Removed/New since last scan
For Stored procedures
COM objects called
ASP pages using procedure
Updated/Removed/New since last scan
Column name, data types, sizes, primary keys, foreign keys
Stored procedures, ASP pages, COM objects and SQL functions using the table
Stored procedures, ASP pages, COM objects using the view
Tables calling the trigger
Tables the trigger is using
For SQL functions
Stored procedures using the function
Tables used by the function
For COM objects
Name, version, Class ID
ASP pages using the object
Stored procedures used by the object
The objects classes and functions
For Include files
ASP pages including this file
(plus the same as for ASP pages)