How you use TechWriter depends on how you want to fit it into your authoring process.  TechWriter can be used in the following ways:

• Authoring with Embedded Comments.  If you create and maintain your comments directly within your web service definition, you might choose to use TechWriter to automate the generation of the documentation directly off those embedded comments.  Using this method, you benefit from keeping the comments embedded in your web service definition up to date.
• Authoring with TechWriter Annotations.  If you want to author and maintain documentation separately from your web service definition, you might choose to use TechWriter to author and generate the documentation.  Using this method, you benefit from the ease of use of TechWriter's authoring environment.
• Round Trip Authoring.  This method can be used if you want to start out authoring the documentation using TechWriter and later embed the comments within your web service definition.  That way you not only benefit from using TechWriter's authoring environment, but you will also have your embedded comments updated.

 

 

---

© 2005-2009 Adivo Ltd. All rights reserved.