Одновременно в подготовке документа могут быть задействованы технические писатели, разработчики, аналитики, тестировщики и руководители проекта. Каждый специалист стремится внести свою лепту в процесс создания документа. Для гармоничной совместной работы создана платформа, позволяющая вносить изменения в документацию с сохранением предыдущих версий – GitBook.
На данный момент GitBook – это онлайн-сервис, который позволяет отображать информацию в виде книги. Gitbook подойдет для создания документации, корпоративных Wiki-систем, баз знаний, справочников по API, обзоров продуктов и др. Процесс работы Gitbook аналогичен репозиториям GitHub (служба размещения репозиториев Git в сети Интернет). Каждому документу создается мастер-копия. На основе мастер-копии может быть создан черновик, который будет похож на «ветку». «Ветки» отражают вносимые изменения в документы. Такой подход позволяет работать над одним документом нескольким пользователям, отслеживая и предотвращая возможные конфликты.
От других платформ для создания документации GitBook отличают следующие возможности:
- интеграция с GitHub и GitLab;
- импорт из Confluence, Notion, Dropbox Paper, Google Docs;
- поддержка Markdown;
- интуитивно понятный интерфейс;
- SSO и SAML, обеспечивающие защиту информации;
- SEO-оптимизация;
- встроенный редактор;
- Slack-уведомления.
Как и у любого продукта, у GitBook также есть ряд недостатков:
- отсутствие возможности размещения аудио и видеофайлов;
- сбои при внесении комментариев (текст комментария отображается с ошибками);
- трудности при одновременном редактировании документа несколькими пользователями (замедленная работа);
- расширенный функционал доступен только по платной подписке (использовать GitBook бесплатно можно только для проектов с открытым исходным кодом).
Для начала работы с сервисом необходимо перейти по ссылке https://www.gitbook.com/. На стартовой странице можно ознакомиться с возможностями платформы, вакансиями в команде GitBook, а также войти в учетную запись. Просмотреть тарифные планы можно во вкладке «Pricing». Подробная инструкция по работе с платформой доступна во вкладке «Education».
После входа в учетную запись для пользователя становится доступной страница Team Library, на которой отображаются все созданные коллекции и пространства. Группировка разделов осуществляется в зависимости от специфики создаваемой программной документации. В нашем случае пространства – это программные документы, а в коллекции объединены документы, связанные с испытаниями (программы и методики испытаний, акты завершения испытаний и др). Для создания пространства или коллекции необходимо нажать на знак «+».
Для импорта контента из Confluence, Notion, Dropbox Paper или Google Docs следует нажать «Import content». В появившейся вкладке необходимо выбрать, откуда будет загружена информация, и перетащить файл.
GitBook – удобный инструмент для взаимодействия специалистов в процессе разработки программной документации. Для использования платформы необязательно обладать специальными знаниями и навыками, что значительно упрощает процесс создания документов.