Поддержка SaaS в системах документирования ПО 14 октября 2010 г. Степалина Екатерина, Кафедра управления разработкой программного обеспечения ГУ-ВШЭ

Одним из конкурентных преимуществ западных продуктов (программного обеспечения, промышленного оборудования) является то, что они ХОРОШО ДОКУМЕНТИРОВАНЫ.

3 Продукт? Информационные системы Фреймворки, библиотеки Сервисы Оборудование

Люди не хотят/не могут пользоваться продуктом, о котором мало информации, или ее сложно найти.

5 О чем? Документирование Системы документирования: CMS, DMS, Wiki Standalone и SaaS-версии (Hosted) систем документирования

6 Документирование – разработка описаний, спецификаций, инструкций по работе с объектами. Документирование считается вспомогательным процессом в разработке ПО. Наличие полной, четкой и правильной документации характеризует качество продукта. Для ПО разрабатываются документы различных видов. Сложность ПО непрерывно растет, объемы документации увеличиваются и возникает необходимость использования специальных СИСТЕМ для разработки и поддержания документов в актуальном состоянии. Процесс документирования строится на основе работы с выбранной системой документирования.

Виды документов Проектные документы Технические документы Пользовательские документы Документация кода 7

Относительные трудозатраты на разных этапах разработки документации по Joann T. Hackos* Планирование информации (Information Planning, 10%) Проектирование (Information Design, 20%) Разработка (Information Development, 50%) Эксплуатация (Production,20%) Оценивание (Evaluation, менее 1%) 8 JoAnn T. Hackos. Information Development: Managing Your Documentation Projects, Portfolio, and People, 2007.

Основные требования к инструменту документирования 9 Требования/Тип документацииПроектнаяТехническаяКомментарии кода Пользовательская Функциональные требования Поддержка многопользовательского режима редактирования НизкийВысокий Re-use контентаСредний НизкийВысокий Удаленный доступ и источнику (через Интернет) Средний Публикация из единого источника в различные форматы НизкийСреднийНизкийВысокий Автоматизированная локализацияНизкий Высокий Нефункциональные требования Защита конфиденциальности информации ВысокийСреднийНизкий Масштабируемость системыНизкийСредний Высокий ОтказоустойчивостьСредний Результаты Число требований с приоритетами Высокий/Средний/Низкий 1/3/41/6/11/3/45/2/0 Эффективность применения SaaS- средств НизкаяСредняяНизкаяВысокая

Виды систем документирования Wiki XML CMS 10

Wiki Wiki обеспечивает свободное размещение материала в базе знаний, где навигация по разделам осуществляется в основном с помощью поиска по ключевым словам. Wiki – это веб-ориентированный формат. Примеры: MediaWiki, TWiki, Doku Wiki, Confluence 11

XML CMS Крупнейшие XML CMS используют архитектуру информационных типов DITA. Для обеспечения полного цикла документирования для работы с DITA обеспечиваются следующие компоненты: –Редактор (XML editor) –Система управления контентом (XML CMS) –Публикатор (DITA publisher) Часто все эти компоненты входят в состав XML CMS. Примеры: Astoria OnDemand, X-Hive Docato 12

Оба типа систем имеют Standalone-версии, которые можно установить на собственное оборудование компании, или на оборудование, арендуемое в ЦОД. 13

Что дешевле? 14

Стоимость Standalone-лицензий Wiki и CMS (1 из 2) 15 Название системы Тип лицензи и Стоимость лицензии на 1 автора Максимально е число авторов Назначение Top 5 Wiki-систем PmWikiGPL 20Не указаноДля любых компаний, конечных пользователей DokuWikiGPL 20Не указаноКак внутренний ресурс для малых и средних компаний MediaWikiGPL0Не указаноДля конечных пользователей, образовательных ресурсов TWikiGPL0Не указаноДля крупных компаний ConfluenceCommer cial 32$ 6$ До 25 От 2000 Для любых компаний Для open source- проектов 0Не ограничено

Стоимость Standalone-лицензий Wiki и CMS (2 из 2) 16 Название системы Тип лицензи и Стоимость лицензии на 1 автора Максимальн ое число авторов Назначение XML CMS для DITA Bluestream XDocs Commer cial От 5000$3Для небольших компаний с жестко ограниченным бюджетом IXIASOFT DITA CMS Framework Commer cial От $Не указаноДля крупных компаний PTC Arbotext Content Manager Commer cial От $Не указаноДля очень крупных компаний Trisoft Infoshare Commer cial Не указаноДля крупных компаний

Современные производители Wiki и XML CMS предлагают SaaS-решения (Hosted). 17

Wiki, имеющие Hosted версии: Open source – BusinessWiki, Metadot Wiki, MindTouch, Wagn, Wikidot; Коммерческие – Confluence, CentralDesktop, EditMe, Incentive, Neticipia, PBWiki, Wikia, Wikispaces. 18

XML CMS, имеющие Hosted версии: (все коммерческие) С полной поддержкой SaaS – Astoria On Demand, DITA Exchange, DocZone; С опциональной поддержкой – Bluestream XDocs, Siberlogic SiberSafe, Trisoft Infoshare, Vasont, X-Hive Docato. 19

Стоимость аренды Wiki и XML CMS-систем (1из 2) 20 Число пользователей В месяцВ год Wiki-системы Confluence Hosted** (с плагинами Gliffy и Balsamiq) -200$400$650$950$-2000 $ 4000$6500$9500$ Подписка на JIRA Studio для разработчиков документации (включает Confluence) 50$100$250$400$500$ 1000 $ 2500$4000$5000$ CentralDesktopОт 15$ От 30$ От 75$ От 300$ От 1500 $ От 180$ От 360$ От 900$ От 3600$ От 6000$ EditMe*От 4,95$ за одну учетную запись

Стоимость аренды Wiki и XML CMS-систем (2 из 2) 21 Число пользователей В месяцВ год XML CMS для DITA Astoria On Demand*От 12000$От $ SiberLogic SiberSafe*От 250$От 3000$ DITA Exchange*От 500$От 6000$ ** Требует подписки на JIRA Studio не менее, чем на 5 программистов. * Цена зависит от количества учетных записей, используемых модулей и является предметом индивидуального соглашения.

Стоимость систем Wiki и XML CMS 22 Бюджет средства документирования/Масштаб продукта НемасштабируемыйМасштабируемый (мультиязычный) 0$Wiki StandaloneWiki Standalone* < 1000$Wiki Standalone, HostedXML CMS Hosted $Wiki StandaloneXML CMS Hosted 5 000$ $Wiki StandaloneXML CMS Standalone Более $-XML CMS Standalone * Не обеспечивает специальной поддержки для мультиязыковой публикации.

Системы и инструменты, доступные по SaaS Общедоступные Google Apps: Google Docs; Wiki-системы: BusinessWiki, Confluence, EditMe; Wiki-системы, интегрированные в систему управления задачами: Confluence в пакете JIRA Studio; DITA XML CMS (может потребоваться редактор и публикатор для DITA): Astoria On Demand, DocZone, DITA Exchange. 23

Ссылки Wikimatrix. Compare them all: wikimatrix.org DITA newsletter: ditanewsletter.com 24

Спасибо за внимание! Вопросы? 25