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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Принцип единого источника. Зачем он нужен?
 
Работаю техническим писателем недавно (2 недели). Зачем нужен единый источник? Чтобы документацию сразу переводить в справку?
 
Цитата
Зачем нужен единый источник? Чтобы документацию сразу переводить в справку?
Ох, нет. Для этого достаточно простого компилятора.

Программы, использующие в своей основе принцип единого источника, позволяют делать значительно больше. Помимо возможности получения на выходе документации различных форматов (doc, pdf, chm, html, xml и т.д.), такие программы позволяют оперативно обновлять документацию (например, изменяется текст в одном месте, при этом во всей документации, где данный текст используется, он изменяется автоматически). Не надо "вручную" отслеживать подобные вещи.

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

Набор шаблонов, библиотек, переменных, сильно облегчают жизнь разработчика документации.

Словом, пока не поиграетесь, всей прелести не оцените. Можно предоставлять документацию в формате pdf или word, используя при этом программу, основанную на принципе единого источника. И не жалеть об этом.

Это все, что сразу приходит в голову. Возможно, кто-то захочет дополнить приведенный выше список.
 
Самое основное забыла - почему "единый источник"
Есть файл-источник (база), который позволяет реализовать то, что я упоминала выше. Кстати, к этому файлу могут быть подключены дочерние файлы-источники.
Я не останавливалась на технической части, т.е. каким образом это все реализовано.
Если что-то осталось за кадром - пишите.
 
Огромное спасибо! В голове немного проясняется. А какая программа для этого подойдет? Я слышал только о docbook ( он бесплатный). Думаю это мне пригодится, хотя на работе у нас пока только WORD и PDF. Вы какой программой пользуетесь? Что посоветуете? С чего начать изучение? И насколько это трудно? :oops:
 
Про docbook - не знаю, не пользуюсь. Думаю, на форуме найдутся спецы. программ много, бесплатных нет (не много, имеется ввиду)  :oops:
Чтобы что-то рекомендовать, нужно знать конечную цель. Если Вы работаете один и только в ворде, то  - одни программы.
Основная цель - перевод документации в другие форматы - другой. Хотелось бы иметь возможность работать  одновременно с коллегами - третий. И т.д. и т.п...
Я уже давно "подсела" на Help&Manual. Господин хирург из дружественного форума, рекомендовал бы AuthorIT, есть любители Robohelp...
Беда в том, что эти программы платные, а в свете легализации ПО привыкать к ним опасно.  :(
H&M мне нравится, как это говорят? А, вспомнила! "Дружественным интерфейсом"! Поддержка их мне нравится. Когда стоял вопрос о выборе программы - остановилась на ней.
Для ваших целей, возможно, подойдет другой инструмент. Только нужно определится, что хочется в итоге получить. А народ на форумах подскажет и опытом поделится.
 
Цитата
Про docbook - не знаю, не пользуюсь. Я уже давно "подсела" на Help&Manual. .
Я только перед выбором, на чтго бы "подсесть"??? А разве Help&Manual тоже поддерживает "принцип единого источника"?
 
Кроме многопользовательского режима - да. Да и это можно обойти - мастер-файлом, к примеру.
Но свое мнение не навязываю. Ибо "Каждая программа имеет право глючить". На момент, когда я стояла перед выбором, это была практически единственная программа, которая более или менее справлялась с кириллицей (из доступных мне программ).
Кстати, писала я в основном о H&M, т.к. его знаю лучше всего.
 
Спасибо [b:iiyxjwzp]Lub[/b:iiyxjwzp], воспользуюсь советом посмотрю HM.
 
Принцип "единого источника" может быть реализован и средствами Ворда, если документы не слишком объемные. С большими файлами Ворд имеет обыкновение "глючить".
На самом деле, нужно четко понять, насколько Вам нужен "единый источник". Я, к примеру, разрабатываю документацию на аппаратно-программные комплексы, где имеются связи между ТЗ, ТУ, РЭ, ПС и ПМ. Самые объемные документы - не более 100 стр. Инструмент - Ворд. Так вот, мне проще при изменении ТЗ внести правки в связанные документы вручную, чем пользоваться "единым источником", хотя это и красиво. Другое дело - случаи, описанные [b:38kpmzqd]Lub[/b:38kpmzqd].
Когда нет знания, есть мнение
 
Полностью согласна с Вадимом. Вначале - цель, потом средства ее достижения.
 
Думаю для начала мне в совершенстве нужно хотя бы овладеть  Word, насколько я понял это совсем не просто ))))).
 
Посмотрите ресурс: http://wordexpert.ru/ . Найдете много полезных вещей :) .
Когда нет знания, есть мнение
 
Цитата
Посмотрите ресурс: http://wordexpert.ru/ . Найдете много полезных вещей :) .
Это просто открытие для меня, спасибо Вадим!
Страницы: 1
Читают тему