Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Документация в формате wiki
 
Всем доброго дня!
Кто-нибудь разрабатывал документацию в формате wiki?
Руководство очень хочет. Сам то я тоже считаю, что это достаточно прогрессивно. Мало кто сейчас может этим похвастаться.
Но есть большое НО!
Конвертация в PDF не очень удачная из wiki-систем, в частности нужно писать css стиль PDF и так далее.

Буду рад, если кто поделится информацией или даже файлом стиля.

Пока пробуем в качестве инструмента Confluence. Может кто знает инструмент получше?
 
MediaWiki имеет множество плагинов, в т.ч. для выгрузки PDF как по одной странице, так и целыми книгами. При чем структуру и иерархию книги можно составлять самостоятельно.
По сравнению с Confluence мало чем отличается кроме цены. В любом случае вам нужно будет создавать стилевые таблицы для кастомного стиля.

Разрабатываю в DITA, а потом публикую в MediaWiki и Confluence и отправляю на сервер. Напрямую в wiki-системе неоправданно долго и мало возможностей. Во-первых неудобная разметка. Во-вторых, если надоест Wiki, то информацию вытащить в другой формат не очень просто. В-третьих, чтобы сохранять изменения, надо делать постоянные бэкапы. Ну и всякие вопросы поддержки версий, структуры стилей тоже требуют внимания - этого нет или есть, но криво. Поддержка самого ресурса с wiki-системой постоянно требует обновления и обслуживания, знаний и денежных вливаний.

Конвертация в PDF удобная из Dita  :D , как и в html, chm и odt. И, заметьте, ни одного платного инструмента нет, в отличии от confluence за $10 в месяц за 1 рабочее место.
 
Дело в том, что confluence у нас уже приобретен и используется для внутренних целях и частично для внешних (часть документации лежит там, которая не требует pdf).

Насколько я понимаю процесс перевода документации из МС офиса в диту весьма трудоемкий? (у нас порядка 5000 страниц).

Что можете посоветовать в такой ситуации?
 
Цитата
Насколько я понимаю процесс перевода документации из МС офиса в диту весьма трудоемкий? (у нас порядка 5000 страниц).

Что можете посоветовать в такой ситуации?
Можно рассмотреть две возможности конвертации:
1. Используя Adobe Frame Maker (он тоже не мало стоит, но наверное все догадываются где можно взять "бесплатно" на пару недель  :D  Trial  или .torrents). Есть плагины для работы с Dita и с Word. Импортировал из Word, просмотрел в редакторе, что-то поправил и сохранил в формате dita.
2. Есть плагины для конвертации из Word (rtf, odt) в Dita, написанные на разных языках (Java, Phyton, PHP etc.)

В обоих случаях должны быть соблюдены минимальные требования к форматированию исходного документа. Свои стили или "продвинутые нестандартные" не прокатят.
 
5000 страниц, из них 20% повторяются?
Там же 10% пространства скриншотов, которые нормально не влазят на страницу?
Еще 5% колонтитулов и отступов?
Оглавления, глоссарии, введения, алфавитные указатели и т.п????

Вообще сложно выделить на это время и посчитать затраты. Это затратно 1 раз. Попробуйте потестить пару страниц.
 
Еще как вариант, начать новый проект или направление документации по другой технологии удовлетворяющей всем требованиям (dita, docbook и т.п.). Всё, что будет считаться  поддерживаемым, но второстепенным и должно сойти "на нет", не нужно никуда конвертировать. Пусть остается в Word в архивах.
 
Вспомнил про вариант Word2DITA Transform.
Есть такой инструмент Dita for Publishers. http://dita4publishers.sourceforge.net/

Там же есть описалово http://dita4publishers.sourceforge.net/ ... arted.html
 
Цитата
Дело в том, что confluence у нас уже приобретен и используется для внутренних целях и частично для внешних (часть документации лежит там, которая не требует pdf).

Насколько я понимаю процесс перевода документации из МС офиса в диту весьма трудоемкий? (у нас порядка 5000 страниц).

Что можете посоветовать в такой ситуации?
Из МС офиса в confluence вроде простой конверт. Сам confluence поддерживает импорт.
Из Confluence в Dita проще, чем из Word в Dita.

Вообще Confluence лучше других вики-систем, хотя бы по возможностям импорта/экспорта в другие форматы. Не стоит от нее отказываться.
 
Цитата
Вспомнил про вариант Word2DITA Transform.
Есть такой инструмент Dita for Publishers. http://dita4publishers.sourceforge.net/

Там же есть описалово http://dita4publishers.sourceforge.net/ ... arted.html
Частично отсвоил этот вариант. С недавнего времени он уже не прокатит как бесплатный. Автоматизированно выпускать документацию не получится. Только вручную и только за деньги.

Нафик.
Страницы: 1
Ответить
Читают тему
Форма ответов
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить файлы
Отправить Отменить