Моя компания в настоящее время поддерживает нашу техническую документацию (Руководство пользователя) в Документах Google. С каждым выпуском я создаю PDF-файл, который мы размещаем на нашем веб-сайте.
Вот функции Google Docs, которые хорошо работают:
И не очень приятно:
Мне поручено найти новый «инструмент», который удовлетворяет следующие потребности:
Я открыт для идей в отношении платформы, хотя мне бы хотелось что-то на основе облака.
Вот что мы делаем для этого. Он не основан на облаке, но поддерживается системой контроля версий, как (надеюсь) ваш код уже существует.
Используемые инструменты и технологии:
управления источником
DocBook DTD
ваш любимый редактор для файлов XML (возможен WYSIWYG)
XSLTProc (с ant, но вместо этого вы можете сделать make или что-то еще)
XEP (генератор PDF)
(устарело, но я все равно упомяну об этом): Компилятор HTMLHelp
Мы пишем наш исходный код документации по DocBook DTD. Это хорошо зарекомендовавший себя стандарт документации, и, хотя вся спецификация большая, вам, вероятно, понадобится всего около 20 XML-элементов (тегов). Здесь есть все обычные вещи — деления (книга, глава, раздел и т. д.), форматирование (выделение, код и т. д.), семантика (имя класса, имя метода, команда, guielement и т. д.), индексирование, оглавление и т. д.
Наряду с исходным кодом DocBook XML есть таблицы стилей, которые переводят ваш XML-вход в любой желаемый результат. DocBook поставляется с некоторыми из них. Мы передаем исходный XML и таблицы стилей XSLTProc для получения промежуточного вывода, объектов форматирования (FO). Затем у нас есть шаг, чтобы преобразовать это в PDF (с использованием XEP), HTML (с использованием XSLTProc) и (мы больше не делаем эту часть) CHM-файл HTML-документа (с помощью компилятора HTMLHelp).
Мы упаковываем все эти шаги генерации в файл сборки ant (ant — это то, что мы уже используем для сборки нашего программного обеспечения), но нет никаких причин, по которым вы не могли бы сделать это с помощью make или любого другого инструмента сборки по вашему выбору.
Источник XML регистрируется в системе управления версиями, и совместная работа осуществляется обычным способом. XML поддерживает включение файлов, поэтому вы можете разделять свои книги на модули по своему усмотрению. Поскольку документы находятся в нашей системе управления исходным кодом, их легко разветвлять и помечать тегами, а автоматизированные ночные сборки включают документацию.
Поскольку источником является XML, а не какой-то двоичный формат, сравнение и слияние работают так, как вы ожидаете, и вы можете использовать любой редактор, который вам нравится. Некоторые из наших людей используют Abortext Epic (довольно высококлассный), некоторые используют Oxygen, некоторые используют NotePad+XML, и по крайней мере один старомодный человек (гм) использует emacs.
Так что я могу многое сделать из вашего вопроса, но...
Возможно, вам стоит потратить время на просмотр пакета для совместной работы ... с таким маленьким магазином он не будет стоить дорого, а инструменты предлагают облачное хранилище и управление версиями, веб-публикацию, вы можете редактировать документы из инструмента ... утверждения, совместное использование , обсуждения, всякое такое. Теперь они ... периферийны по отношению к любому инструменту, который фактически создает документ. Таким образом, вы можете разместить документ Word или PDF в облаке с помощью одного из этих инструментов (Word может управлять всеми перечисленными вами элементами). Я не видел инструмента, который одновременно создает и публикует документы (по крайней мере, неэффективно ...) они могут быть интегрированы и от одного и того же поставщика, но обычно это два инструмента.
Итак, я думаю, мое предложение сводится к тому, чтобы использовать инструмент для создания документов, который вы хотите, а затем использовать инструмент для совместной работы для управления публикацией, обзорами, параллельной работой и т. д.
Взгляните на некоторые из следующих.
Этот инструмент рассчитан на 10 пользователей в месяц и предлагает совместное использование документов и совместную работу.
Huddle немного дороже, 20 пользователей в месяц, но он очень многофункционален... он может делать множество интересных вещей, включая готовые приложения для мобильного доступа.
Этот немного менее надежен, но бесплатен для 20 пользователей.
Надеюсь, это поможет, если я отклонюсь от цели, дайте мне знать, я всегда могу удалить этот ответ.
Я бы сказал, что вы ищете облачный инструмент для создания справки (HAT), будь то SaaS или размещенный на серверах в вашей компании.
Мы использовали WebWorks ePublisher , который выводит в нескольких форматах HTML (например, собственный HTML-вывод WebWorks, HTML-справку и т. д.). Он также предлагает локальный облачный хостинг (CloudDrafts). Его главная сила заключается в огромном количестве выходных данных, которые он предлагает, что может быть излишним в вашем случае, но, тем не менее, на него стоит обратить внимание.
Вы также можете рассмотреть некоторые решения SaaS, такие как ClickHelp . Некоторые поставщики, такие как MadCap Software, предлагают свои HAT в сочетании с дополнительным решением, которое необходимо приобрести, чтобы сделать его облачным.
У меня есть дополнительный список SaaS HAT на DocToolHub , если вы заинтересованы... просто выберите фильтры для «инструментов для создания справки», «SaaS» и «PDF».
Если вы хотите поддерживать документацию для нескольких продуктов, повторное использование контента (более эффективным способом, чем копирование и вставка) становится желательным. Если это так, такой инструмент, как Author-it, соответствует вашим требованиям: несколько выходных форматов, включая PDF и HTML, правильное форматирование книги (TOC, указатель и т. д.), настраиваемые стили.
Его функции совместной работы структурированы немного иначе, чем в модели Google Docs: один автор может работать над фрагментом текста за раз, но этот фрагмент текста может быть небольшим (один раздел). Автор настраивает рабочий процесс рецензирования, в котором другие могут комментировать, но не могут напрямую изменять источник. Это предотвращает войны редактирования и испорченный кропотливо написанный контент любителями.
Что отличает его от обычных офисных инструментов для совместной работы, так это возможность повторного использования контента от отдельных предложений до целых глав. Это экономит много времени, если вы создаете документацию для нескольких продуктов.
Мы используем Help & Manual уже семь лет. Имеет примерно 8 выходных форматов, использует XML в качестве серверной части, отлично интегрируется с svn и легко переводится с помощью OmegaT. Разрешает одновременные пользовательские лицензии (у нас их две).
Джеймс
тмакаллаган