TechWriter for Web Services is a handy program that allows you to create documentations for web services. TechWriter for Web Services will leverage the information locked inside your web service definition to automatically produce web service API documentation.
For many industries and agencies, providing documentation has become mandatory for: CMMI Certification, Security Certification and Accreditation Processes, FDA regulated validation procedures, and ISO 9000.
With the ever changing nature of IT, it is more critical than ever to have your systems properly documented - providing quality doc for your web services is no exception.
Here are some key features of "TechWriter for Web Services 2009":
Supported Web Services:
· Any web service that is defined by a Web Service Definition Language (WSDL) file or can produce a WSDL.
· WSDL can be accessed as either a local file or through an HTTP or HTTPS web request.
· REST web services.
Web Service Objects Documented:
· Services, Methods, Parameters and Faults.
· Elements, Attributes and Types used to define the method parameters.
· Cross References.
Supported Output Formats:
· PDF (Portable Document Format)
· Compiled Help / HTML Help 1.x File (CHM)
· Word/RTF (DOC)
· HTML Page (single-page HTML)
· Web Site (multi-page HTML)
· DocBook XML
· XPS (XML Paper Specification) Document
Advanced Filtering:
· Filter the methods, elements, attributes and types that you want to include or exclude through an easy-to-use checkbox interface.
· Filter based on wildcard patterns that match the names of your web service objects.
Annotations:
· WYSIWYG annotation editor for adding and revising web service descriptions and remarks.
· Rich content model that supports formatting of paragraphs, lists, tables, images, hyperlinks and more.
· Import and export annotations to and from comma-delimited and XML files.
Customizations:
· Custom language file allows over 100 alternate values for output headings and text. Can be used to support other languages or produce highly customized output.
· Control the level of detail included in the topic page for each web service object by selecting from over 30 sections of conditional content.
Optional Command Line Interface:
· Can be called from build tools (e. g. MSBuild, Ant, NAnt).
· Parameters allow you to specify the project file, output type and a refresh switch.
PDF Output Features:
· Printable table of contents with page numbers and hyperlinks
· Bookmarks for navigation
· Printable index with page numbers and hyperlinks
· Page headers and footers
Compiled Help Output Features:
· Table of contents for navigation
· Search tab for full-text searching
· Index tab containing generated index terms
· Page headers and footers
Web Site/HTML Page Output Features:
· Template-driven output
· Configurable top-level page name
· Configurable table of contents
Word/RTF Output Features:
· Table of contents
· Page headers and footers
Requirements:
· NET Framework 2.0
· Acrobat Reader
· Intel Pentium II or compatible, 166 MHz or higher.
· Memory (RAM) 512 MB
· Hard disk free space 1000 MB
Limitations:
· 15 days trial
· Nag screen
What's New in This Release: [ read full changelog ]
· 'Select All' and 'Clear All' buttons
· New buttons added to the Options tab.
· New Build Menu option
· Option for opening the output folder after the build.
· Improved MySQL Support (TechWriter for Databases)
· MySQL Connector/NET dependencies eliminated.
· REST Services that use HTTP Headers (TechWriter for Web Services)
· Support for setting HTTP headers added to REST web service settings.
· Local Sub-Elements (TechWriter for Web Services)
· New option for including local sub-elements in content model.
· Merge Across Services (TechWriter for Web Services)
· Ability to merge topics across multiple services.
· Merge Annotations into XSDs (TechWriter for Web Services and XML Schemas)
· Ability to merge your annotations back into your XSDs.
Find us on Google+
