TechWriter для web Services — это генератор документации для веб-сервисов, который использует информацию, заблокированную в определении веб-сервиса, для автоматического производства документации API веб-сервиса.
...
Производство автоматизированной документации API web Service
...
Экономьте время и деньги... Вместо того, чтобы тратить часы на написание и форматирование технической документации с нуля, вы можете закончить работу в считанные секунды с TechWriter. Создание первого справочного документа находится всего в нескольких кликах мыши.
...
Держите синхронизированы ... Никому не нравится устаревшая системная документация. Включив TechWriter в процесс разработки, ваша документация может быть восстановлена по мере изменения веб-сервиса.
...
Легко ориентироваться на разные аудитории... Дайте вашим читателям документацию, которую они могут понять, редактируя и расширяя описания ваших методов, аргументов и типов веб-службы.
...
Выберите свой формат вывода... Создавайте одновременно как печатную, так и онлайн-документацию. TechWriter может создавать вашу документацию в форматах PDF, Compiled Help (CHM), Word/RTF и HTML.
...
Документирование нескольких web-сервисов... TechWriter поддерживает документирование веб-сервисов на основе SOAP, которые определяются файлом Web Service Definition Language (WSDL 1.1), а также службами на основе REST. И лучше всего, вы можете смешивать и сопоставить их для производства одного документа, который описывает несколько веб-сервисов.
...
Хорошая практика... Для многих отраслей промышленности и учреждений предоставление документации стало обязательным для: сертификации CMMI, процедур сертификации безопасности и аккредитации, регулируемых FDA процедур проверки и ISO 9000. С постоянно меняющимся характером ИТ, это более важно, чем когда-либо, чтобы ваши системы должным образом документированы - предоставление качества документ для ваших веб-сервисов не является исключением.
история версии
- Версия 2009.R3 размещено на 2010-07-14
Поддержка таблиц и изображений WYSIWYG, поддержка вывода XPS, поддержка документирования услуг REST.
- Версия 2007.v5 размещено на 2008-12-28
Выпуск 5.0: Улучшенный генератор документации для веб-сервисов
Подробная информация о программе
Eula
EULA - Соглашение о лицензировании конечных пользователей
ЛИЦЕНЗИОННОЕ СОГЛАШЕНИЕ ПО ПРОГРАММНОМУ ОБЕСПЕЧЕНИЮ
1. Предоставление лицензии
Adivo Ltd (Квота;Адивоцит;) предоставляет клиенту лицензию на использование компьютерного программного обеспечения TechWriter компании Adivo (квота;Software;) на одном компьютере.
2. Использование программного обеспечения
а. Adivo представляет, что он является владельцем программного обеспечения и что он имеет право предоставить лицензию. Стороны согласны с тем, что программное обеспечение является единственной и исключительной собственностью Adivo, включая все применимые права на патенты, авторские права, товарные знаки и коммерческую тайну и предоставляется для исключительного использования Заказчиком для целей настоящего соглашения.
B. Клиент не будет удалять знак обозначения из любого поставляемого материала, который идентифицирует такие материалы как принадлежащие или разработанные Adivo. Клиент соглашается не разбирать, не декомпировать, реверсивного инженера или иным образом уменьшить программное обеспечение до заметной формы.
c. Ни в одном случае копия или причина копирования дубликатов Программного обеспечения Заказчик не может сделать одну копию Программного обеспечения для резервного копирования.
d, Клиент не должен подраздать, назначить, передать использование, скопировать или изменить Программное обеспечение, за исключением случаев, которые прямо предусмотрены в настоящем Соглашении, и любая попытка сделать это должна быть недействительной.
3. Гарантия
a. EXCEPT AS EXPRESSLY SET FORTH HEREIN, ADIVO MAKES NO WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, ПОДРАЗУМЕВАЕТ ГАРАНТИИ MERCHANTABILITY И FITNESS FOR A PARTICULAR PURPOSE. В случае, если Adivo не в состоянии исправить материальные дефекты в программном обеспечении, единственным средством правовой защиты клиента должно быть получение возмещения любых лицензионных сборов, уплаченных в настоящее время в течение текущего срока действия этой лицензии.
b. ADIVO SHALL HAVE НИКАКОЙ ОТВЕТСТВЕННОСТИ С УВАЖЕНИЕМ К СВОИМ ОБЯЗАТЕЛЬСТВАМ В СООТВЕТСТВИИ С ЭТИМ СОГЛАШЕНИЕМ ИЛИ ИНЫМ ОБРАЗОМ ДЛЯ КЛИЕНТА ДЛЯ СПЕЦИАЛЬНЫХ, СЛУЧАЙНЫХ, КОСВЕННЫХ, ШТРАФНЫХ ИЛИ ОБРАЗЦОВЫХ УБЫТКОВ EVEN IF ADIVO HAS БЫЛО СООБЩЕНО О ВОЗМОЖНОСТИ ТАКИХ УБЫТКОВ. НИ В КОЕМ СЛУЧАЕ ОТВЕТСТВЕННОСТЬ ADIVO НЕ ДОЛЖНА ПО КАКОЙ-ЛИБО ПРИЧИНЕ И ПО КАКОЙ-ЛИБО ПРИЧИНЕ ДЕЙСТВИЙ ПРЕВЫШАТЬ ПЛАТЕЖИ, СДЕЛАННЫЕ КЛИЕНТОМ ADIVO В СООТВЕТСТВИИ С ЭТИМ СОГЛАШЕНИЕМ.
4. Ограничение ответственности
НИ ПРИ КАКИХ ОБСТОЯТЕЛЬСТВАХ И НИ ПРИ КАКИХ ПРАВОВЫХ ТЕОРИЯХ, ДЕЛИКТ, КОНТРАКТ, ИЛИ ИНЫМ ОБРАЗОМ, ДОЛЖНЫ ADIVO, НЕСЕТ ОТВЕТСТВЕННОСТЬ ПЕРЕД ВАМИ ИЛИ ЛЮБЫМ ДРУГИМ ЛИЦОМ ЗА ЛЮБОЙ КОСВЕННЫЙ, СПЕЦИАЛЬНЫЙ, СЛУЧАЙНЫЙ ИЛИ КОСВЕННЫЙ УЩЕРБ ЛЮБОГО ПЕРСОНАЖА, ВКЛЮЧАЯ, БЕЗ ОГРАНИЧЕНИЙ, УБЫТКИ ЗА ПОТЕРЮ ДОБРОЙ ВОЛИ, ОСТАНОВКУ РАБОТЫ, КОМПЬЮТЕРНЫЙ СБОЙ ИЛИ НЕИСПРАВНОСТЬ, ИЛИ ЛЮБЫЕ И ВСЕ ДРУГИЕ КОММЕРЧЕСКИЕ УБЫТКИ ИЛИ УБЫТКИ. ЭТО ОГРАНИЧЕНИЕ ОТВЕТСТВЕННОСТИ НЕ РАСПРОСТРАНЯЕТСЯ НА ОТВЕТСТВЕННОСТЬ ЗА СМЕРТЬ ИЛИ ТЕЛЕСНЫЕ ПОВРЕЖДЕНИЯ В ТОЙ МЕРЕ, В КАКОЙ ПРИМЕНИМОЕ ЗАКОНОДАТЕЛЬСТВО ЗАПРЕЩАЕТ ТАКОЕ ОГРАНИЧЕНИЕ.
5. Закон об управлении
Это Соглашение должно быть истолковано в соответствии с законами штата Огайо
6. Подтверждение
Заказчик признает, что он или она прочитали это Соглашение, понимает его и соглашается быть связанным его условиями. Клиент также соглашается с тем, что это все Соглашение между Заказчиком и Adivo и что не было никаких других гарантий, представлений, заветов или взаимопонимания, касающихся предмета настоящего Соглашения.