Glossary Item Box

TechWriter 2009 for Databases Send comments on this topic.

Authoring with Embedded Comments

Because TechWriter is able to leverage the comments embedded in your database definition, it is possible to only utilize TechWriter for generating the final documentation as shown in the following diagram:

Authoring with Embedded Comments

 

This type of authoring involves the following activities:

    1. Comments are created and maintained directly within your database definition by its implementer.
    2. TechWriter is used to extract those comments to generate the documentation.

Because this type of authoring does not involve using TechWriter to edit the comments, you will need to know the details of the comment model being used in order to properly format the comments.

 

 


© 2005-2009 Adivo Ltd. All rights reserved.