Glossary Item Box

TechWriter 2009 for Databases Send comments on this topic.

Round Trip Authoring

As the name implies, round trip authoring involves extracting the comments embedded in your database definition, editing them with TechWriter, and applying those updates back to your definition as shown in the following diagram:

Round Trip Authoring

This type of authoring involves the following activities:

    1. The Documentation Author uses TechWriter to extract the details of your database, including embedded comments, from it's definition to provide a snapshot of what is being documented.
    2. The Documentation Author uses TechWriter to edit the comments associated with the definitions that make up your database
    3. The Documentation Author uses TechWriter to generate the documentation and export the updated comments to a script file.
    4. The Database Implementer uses the export file to update the definition.

 

 


© 2005-2009 Adivo Ltd. All rights reserved.