Хранение документации

Материал из Tair Wiki
Перейти к: навигация, поиск

Хранение документации, организация общего доступа, контроль версий

Проблему общего доступа к документации, а так же ее правку с автоматическим сохранением версий, можно решить несколькими способами: разместить документы в хранилище с общим доступом и определить регламент работы, использовать системы управления версиями или специализированные программы для создания технической документации. Если документ хранится в удаленном хранилище, то приходится заново закачивать полную копию всего документа, если он был изменен. И если документ большого размера, то это увеличивает затраты на сетевой трафик. Одновременное изменение несколькими пользователями и слияние таких измененных документов в один весьма проблематично. Специализированные программы для создания технической документации имеют единую централизованную библиотеку для всех пользователей. Они будут сами отслеживать изменения, сделанные другими пользователями и автоматически вносить правки.


Sharepoint.png
Загруженное.jpg
TortoiseSVN.png
Perforce.png
Starteammmm.png
1.png
Confluence.jpg
Doc book logo.png
Focusareas logo.jpg
AIT-logo.png
Help manual logo.png
Bg head welcome png24.png

On-line хранилища с правом редактирования

SharePoint - При наличии учетной записи SharePoint или Microsoft OneDrive можно сохранить файлы Word в одной из этих служб, а затем с помощью команды Общий доступ предоставить доступ к ним другим пользователям с правом на чтение или редактирование. Доступные другим пользователям действия над файлом зависят от того, какие разрешения им предоставлены.

Google Docs - это бесплатный онлайн-офис, включающий в себя текстовый, табличный процессор и сервис для создания презентаций, а также интернет-сервис облачного хранения файлов с функциями файлообмена, разрабатываемый компанией Google. Это веб-ориентированное программное обеспечение, то есть программа, работающая в рамках веб-браузера без инсталляции на компьютер пользователя. Документы и таблицы, создаваемые пользователем, сохраняются на специальном сервере Google, или могут быть экспортированы в файл. Это одно из ключевых преимуществ программы, так как доступ к введённым данным может осуществляться с любого компьютера, подключенного к интернету (при этом доступ защищён паролем). Поддерживает загрузку новых версий одного и того же файла.

Ограничения на размеры: Документы. 1 024 000 символов независимо от количества страниц и размера шрифта. Размер загруженных файлов, преобразованных в формат Google Документов, не может превышать 50 МБ. Таблицы. 400 000 ячеек во всей таблице и не более 256 столбцов на листе. Размер загружаемых таблиц, преобразованных в формат Google, не должен превышать 100 МБ. Количество ячеек и столбцов должно соответствовать указанным выше числам. Презентации. Размер презентаций Google не может превышать 100 МБ. Размер загружаемых презентаций, преобразованных в формат Google, не может превышать 50 МБ. Другие файлы. Максимальный размер файлов, которые можно загружать без преобразования в формат Google Документов, Таблиц или Презентаций, составляет 5 ТБ. Для хранения данных в Gmail, на Google Диске и в Google+ Фото мы предоставляем каждому пользователю 15 ГБ свободного места. Кроме того, вы можете приобрести дополнительное пространство.

Dropbox - облачное хранилище данных, принадлежащее компании Dropbox Inc., позволяющее пользователям хранить свои данные на серверах в облаке и делиться ими с другими пользователями в Интернете. Работа построена на синхронизации данных. Осуществляется контроль версий, но в истории изменения записывается только отличие одной версии файла от другой. Файлы, загруженные через клиент, не имеют ограничения на размер, но файлы, загруженные через веб-интерфейс, ограничены 300 МБ. Для совместной работы над проектами сервис имеет возможность создания «Shared» папок для общего доступа лиц, имеющих разные учетные записи на сервисе. Доступна автоматическая синхронизация файлов и папок и хранение версий с возможностью отката. Dropbox не использует шифрование данных на стороне клиента. Сервис предлагает бесплатно 2 ГБ для хранения данных, которые можно увеличить бесплатно до 16 ГБ, приглашая новых пользователей или же получить несколько гигабайт после выполнения заданий (установка приложения Dropbox на мобильный телефон и т.д.). А также можно купить 100 ГБ или больше.

OneDrive — это бесплатное интернет-хранилище, предоставляемое вместе с учетной записью Майкрософт. Это словно дополнительный жесткий диск, доступный со всех используемых вами устройств. Больше не нужно отправлять себе файлы по электронной почте или носить с собой USB-устройство флэш-памяти, рискуя его потерять. Работая над презентацией на ноутбуке, просматривая фотографии с семейного отпуска на планшете или составляя список покупок на телефоне, вы сможете использовать свои файлы из OneDrive. Размер хранилища указан от 2 ГБ до 15 ГБ бесплатного места. Работает в версих W7, 8, Vista, Не работает в XP.

Системы управления версиями

Система управления версиями позволяет хранить несколько версий одного и того же документа, при необходимости возвращаться к более ранним версиям, определять, кто и когда сделал то или иное изменение, и многое другое. Большинство систем управления версиями может отслеживать и объединять изменения, сделанные разными людьми при условии, что изменялись разные части документа. Если была изменена одна и та же часть документа, система предложит решить эту проблему вручную. Если основными требованиями компании являются общий доступ к правке документа и контроль версий, то можно обойтись привычном редактором текста в комплекте с программой контроля версий.

Tortoisesvn - это бесплатный Windows-клиент с открытыми исходным кодом для системы управления версиями Apache™ Subversion®. То есть TortoiseSVN управляет файлами и директориями во времени. Файлы хранятся в центральном хранилище. Хранилище больше похоже на обычный файловый сервер, кроме того он запоминает каждое изменение когда-либо сделанное в ваших файлах и директориях. Это позволяет вам восстановить старые версии ваших файлов и проверить историю изменений — как, когда и кто изменял ваши данные.

Perforce - коммерческая система управления версиями. Доступна бесплатная лицензия для двадцати пользователей. Система имеет клиент-серверную архитектуру.

StarTeam - автоматизированная комплексная система управления конфигурацией программного обеспечения (SCM), которая поддерживает управление циклом приложений с использованием отдельного репозитария. Защищенный и при этом гибкий доступ гарантирует, что участники коллектива могут работать там и тогда, где и когда им нравится. StarTeam входит в семейство продуктов Borland ALM, которое предлагает уникальное всеобъемлющее решение. Оно осуществляет интегрированное управление изменениями, отслеживание ошибок, контроль версий файлов, управление требованиями, цепочки обсуждений и управление проектами и задачами.

Mercurial - это современная распределенная система контроля версий с открытым кодом. Ветки несут проблемы при работе с Subversion, потому что Subversion не хранит достаточно информации для того, чтобы слияние (merge) нормально работало. В Mercurial слияние безболезненно и легко, а потому ветвление распространено и безвредно. В Subversion мыслят ревизиями. Ревизия — это то, как выглядит вся файловая система в определенный момент времени. В Mercurial вы мыслите наборами изменений (changesets). Набор изменений — это четкий список изменений между двумя соседними ревизиями. Subversion, по сути, система контроля изменений для файлов, а в Mercurial контроль изменений применяется ко всему каталогу, включая все подкаталоги.

Специальные программы

Большинство автоматизированных систем разработки технической документации построены на основе принципа единого источника информации. Применение технологии единого источника занимает много времени на этапе внедрения: сначала проектируется структура единого источника, разрабатываются шаблоны и стили оформления, устанавливается и настраивается инструментарий для формирования документов. Только потом – написание текста и загрузка его в общий источник. В любой момент на основе введенного текста можно сформировать документы, в большей или меньшей степени готовности. На этой стадии мы получаем отдачу от сделанных вложений. Раздел, рисунок, таблица, абзац, любой другой фрагмент, который должен появляться в нескольких местах, при необходимости достаточно исправить однократно в едином источнике. Крупные интегрированные среды для автоматизации документирования, такие, как AuthorIT, SiberSafe, RoboHELP, предоставляют для этого различные средства: управления правами доступа, версионный контроль, планирование работ и т.п.

Реализация документации на основе единого источника

Какие бывают системы документирования:

  • Закрытые решения - интегрированные среды разработки (help authoring tools)
  • Специальные CMS – Wiki системы
  • Открытые технологии основанные на XML - DocBook, DITA

DITA — это такая технология разработки технической документации. Она популярна сегодня, во многие специализированные среды и XML-редакторы встроена ее поддержка. Оформление текста в этом документе определяется стилями, которые были подготовлены заранее самим автором или кем-то другим. На выходе получается документ в том или ином формате, например, PDF или HTML. Таким образом, происходит экономия времени за счет того, что все оформление делает сама программа.

DocBook - структурно-ориентированная система: раздел, подпункт, пункт, абзац. Меньшая гибкость, по сравнение с DITA.

Основные преимущества формата Docbook:

  • Унифицированное форматирование. Использование фиксированного набора тегов гарантирует, что конечный документ будет корректно сформирован в независимости от количества авторов
  • Работа с системами контроля версий
  • Модульность. Применяемый формат позволяет легко разделить документ на независимые части для упрощения работы над большими документами. При работе удобно разбивать документ на главы, причем широко практикуется создание документов одновременно на нескольких языках
  • Многовариантное представление документов. Разделение контента и форматирования в XML формате Docbook позволяет трансформировать один и тот же документ во множество различных форматов


AuthorIT - программа для автоматизации разработки технической документации AuthorIT открывает возможность многопользовательской работы. Обеспечивается возможность удаленной работы как онлайн-прямой связи с библиотекой по сети Интернет, так и с оффлайновыми копиями библиотеки. Библиотека является единым централизованным хранилищем;

Adobe RoboHelp

MadCap Flare

Help&Manual - программы для создания файлов справочной системы. Help & Manual Professional позволяет создавать файлы и документацию различных help-форматов. Главным преимуществом программы является ее универсальность. С ее помощью можно получить файл справочной информации в любом из наиболее распространенных на сегодняшний день форматов (CHM, HLP, HXS, HTML, PDF, RTF, EXE, XML). Редакция Help & Manual Professional предназначена для профессиональных авторов, разработчиков ПО и небольших организаций. Включает обширные возможности: от создания документов HTML Help и Webhelp и публикации файлов на iPad, до контроля версий, трансляции и локализации документов. Реализован встроенный многопользовательский функционал

EMC Documentum

Dr.Explain

MindTouch

Wiki системы:

  • MediaWiki
  • TWiki
  • PmWiki
  • Confluence

Atlassian Confluence — тиражируемая вики-система для внутреннего использования организациями, занимающимися проектами по разработке программного обеспечения, в частности, будет востребована отделами документирования программных продуктов.

Возможности Atlassian Confluence:

  1. Удобный текстовый редактор
  2. Совместное планирование
  3. Отслеживать изменения
  4. Контроль над редактированием и публикации технической документации.
  5. Экспорт документации из «единого источника» в различные форматы:
    1. PDF
    2. Word
    3. формат XML
    4. HTML
  6. Импорт документов из
    1. Word
    2. DITA XML
    3. Adobe FrameMaker

Atlassian Confluence позволяет «собирать» документацию из «топиков» и создавать на основе них новые документы. Создавать библиотеку готовых «топиков» со стандартными «кусками» документации, такими как : авторские права, глоссарии, титульные страницы, схемы, сценарии, которые можно использовать в других документах и книгах. Из последних нововведений – возможность работать с мобильного телефона. Confluence поддерживает систему контроля версий и позволяет настроить права доступа к страницам и документам, что позволит вам выбрать тех, кто может просматривать, редактировать и комментировать ваши проекты.

Каждый отредактированный файл сохраняется в виде новой версии, что позволяет легко сравнить сделанные изменения и при необходимости вернуться к предыдущей версии.

XML CMS для работы с Dita:

  • Horizon
  • CDocx
  • X-Hive/Docato
  • TEXTML Server (DITA CMS Framework)
  • Contenta

SiberSafe - программы для создания технической документации. Обладает такими функциями, как: общий доступ; совместная работа, поиск и индексирование, управление версиями.