Задать вопрос
DruDro
@DruDro
Технический Писатель

Какую CMS выбрать для ведения документации нескольких проектов?

По роду деятельности мне приходится работать со многими инструментами для написания доки, руководств пользователей, руководств разработчиков и других ководств. Каждый день задачи разные, решаемые разными способами и инструментами: от Help&Manual и Microsoft HTML Help Workshop до самописных программок, компилирующих и собирающих хелпы в нужные форматы.
Компания, где я работаю, выпускает множество продуктов для разработчиков под разные цели, языки программирования, IDE, операционные системы, базы данных и т.д. Отсюда и необходимость собирать множество форматов одной и той же справки: PDF, CHM, HXS, DOC, а также онлайн-хелп. И вот настал тот момент, когда для написания документации каждого продукта приходится использовать разные третье-сторонние инструменты, отличающиеся генерируемым форматом справки.
В связи с этим я ищу CMS со следующими возможностями:
  • Разделение прав писателей доки в админке. Чтобы каждый участвующий TW мог править свою ветку документации на сайте (по проектам, продуктам, продуктовым линейкам).
  • Возможность создания и ведения нескольких проектов, с разным дизайном, разными авторами, в идеале - на разных субдоменах или ветках сайта
  • Экспорт/Импорт/Конвертер различных форматов справки: CHM, PDF, RTF, XML и его подмножеств (FB2/EPUB)
  • Возможность добавлять отдельные HTML-статьи
  • Многоязычность
  • Расширенный WYSIWYG-редактор
  • ЧПУ


Среда реализации не имеет значение, хоть на Delphi - лишь бы могло всё это.
Любой ответ будет полезен.
P.S. если встречали модули для неспециализированных CMS - делитесь ссылками - буду рад потестировать.
  • Вопрос задан
  • 1199 просмотров
Подписаться 2 Оценить Комментировать
Пригласить эксперта
Ответы на вопрос 3
@LuchS-lynx
инженер-ПТО
xwiki:
- как и любой вики-движок позволяет гибко настраивать права доступа, как по группам, так и для отдельных пользователей;
- нет ничего проще - внутри Сайта вики-движок позволяет создать сколь угодно большое число субвики, со своими локальными/глобальными пользователями, правами, привилегиями, настройками, плагинами, скинами и т.д.;
- по умолчанию позволяет сохранять в pdf любую страницу, если поставить аддон, то якобы (я не тестил лично), можно выгрузить в pdf всю вики. Что касается поддержек других форматов, страницы из pdf, при условии что они набрана в редакторе xwiki, легко копируется в офис с последующим экспортом во все подряд;
- синтакс html поддерживается, как и программные скрипты (Velocity, Groovy, Python, Ruby and PHP), так же есть вариант для html с макросом;
- интерфейс переведен на многие языки, включая русский. Перевод и отображение текстов на русском языке корректен, проблем с кириллицей нет, кроме семантического поиска (формы слова "окно" и "окна" для внутреннего поиска одно это разные слова);
- есть поддержка OpenOffice (необходимо настраивать руками), WYSIWYG-редактор стандартный, при этом удобное переключение (2 вкладки) на обычный текстовый и обратно;
- если речь о ссылках -то:
поддержка русского языка упирается в механизм работы со ссылками, который для русского языка создает ссылки вида:
Wiki Home\Test page\страница с пробелами
http://*Ваш_сайт*/xwiki/bin/view/Test+page/%D1%81%...
На сколько я понимаю — это Unicode, или аналог. В принципе, если не зацикливаться на том что отображается в строке ввода ссылки в браузере, сам движок предложит создать ссылку вида:
[[страница с пробелами>>doc:Test page.страница с пробелами]] — это внутренняя ссылке, хотя он переваривает и внешние вида: http://*Ваш_сайт*/*Ваш_путь*
Ответ написан
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
Формат: Docbook/XML (начиная с 5.1) или DITA
Хранение: GIT/SVN
Authoring tool: любой, к которому адаптируются писатели
Публикация - Apache Cocoon (для realtime публикации), либо скриптовая сборка (если требуется просто "отдавать файла")

По умолчанию присутствуют:
1. Многоязычность.
2. Вывод deliverable в зависимости от цели (аудитория/ОС/заказчик и т.п.)
3. Форматы: PDF, html, ePub, word roundtrip (но требуется доработка).
4. Версионность хранения (diff/merge).

Можно еще долго перечислять, но если действительно заинтересуют подробности (применение каждого пункта, особенности и т.п.), то дайте знать комментом.
Ответ написан
Salangin
@Salangin
Technical writer
Atlassian Confluence
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы