genhtml-0001.jpg
This document describes a very fast technique to generate installation and
customization documentation in projects with customers. Customers are often positivly
impressed by a good and detailed documentation. Documentation is one of the key points for
the success of a project.
This approach is very fast because
- We use a state of the art screen-shot utility to make pictures of current activities.
- We generate for each activity i.e. Windows NT Network card installation an unique
screenshot directory.
- We use genhtml.exe to generate the index.htm for this documentation.
- We use a WEB-Server to publish the documentation in the intranet of the customer and in
the intranet of our consulting company.
This documentation was generated with genhtml.exe in just a few minutes!
First I'd like to start with the configuration of the screen-shot utility to allow
fast documentation.
|
genhtml-0016.jpg
Genhtml.exe supports image files with the following extensions (see genhtml -help):
JPG PDF GIF JPEG
Files with this extension are automatically added to index.htm .
Files with the same name as the image and one of the extensions htm txt (see genhtml -help) will be opened and the contents of these files will be added to index.htm.
This allows you to add comments to images. A WEB index server can be used to add the text-files to make the documentation searchable!
On the opposite you may enter the text into an editor and screen-shot this if you have to be very fast in documentation. But this approach has the disadvantage that an indexing server might not find any keywords.
|