The most important knowledge is in the heads of developers and key users, and if it is not manifested in written form, important information can be lost.
The creation of automated technical documentation saves time and money. It also helps to create a history of changes in the system and to meet legal requirements. On the other hand, the technical details alone are often not sufficient to gain a quick understanding of complex developments.
To provide all objects with a comprehensive repository of important information, the Docu Performer offers the following types of comments:
Template-based comments
The template-based comments serve to create detailed, formatted comments that can be integrated into the technical documentations of entities. In order to provide a predefined structure of the user comments, Comment Templates can be created for each entity type.
When defining a Comment Template, the template headers of each included item will ensure that important information areas are not forgotten. The Comment Template will then guide the user through the required steps of the comment creation and it will support this task in an efficient way. The user can thus concentrate on the content and will not have to think about what kind of information would be important for the specific entity type.
With the Commenting Module of the Docu Performer, the unpopular task of documenting and commenting becomes an easy and enjoyable job.
When using the module “Commenting” we recommend installing the application’s database on an SQL Server or Oracle database. It is also possible in combination with the SQLite Database, but not recommended.
You can search all template based comments using the Search in comments functionality
Grid comments
Grid Comments are short comments to entities that can directly be maintained in the grid. The comments will be exported to Excel if the comment columns are visible in the grid.
- Using the "Search in the grid" functionality all grid comments can be searched for certain strings
- Using the "Auto Filter Row" grid comments can be filtered