SQLHelp produces database documentation for the stored procedures in your database project. The documentation includes the input parameters, their types and directions, output result sets, executed procedures, return values, and transactional nature, independent of the path of execution. Extended capabilities include declarative procedure grouping, hyperlinked executed procedure access and query analyzer style syntax color coding. All documentation is generated via SQL batch files and requires no active database connection.
SQLHelp produced documentation is perfect as printed database documentation for clients, online access for middle tier developers to develop against a documented database interface and quality assurance efforts to ensure consistent coding guidelines are followed. SQLHelp documentation can also be produced at the beginning of projects to help define the interface contract between the database layer and its consumers.
In documenting the procedures as you design them, and by defining an interface contract, you can ensure the stability and reliability of your end application. SQLHelp produces compiled HTML Help formatted documentation that is familiar to virtually every developer working on Microsoft platforms.
Some of the capabilities include:
- Document SQL stored procedures easily and quickly.
- Define logical groupings of procedures.
- Produce compiled HTML Help of the procedures running on your database for future reference.
- Enforce object oriented design techniques by defining interfaces to your database.
- Limit access to the raw SQL to those who need access.
