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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Что такое "Единый источник"
 
Меня просто интересут что такое, так называемый "единый источник", знакомые технические писатели даже понятия не имеют об этом. Уменя представление такое:
1.Большая компания
2. Несколько технических писателей
3. Каждый пишет свой раздел
4. Из этих кусочков складывают объемный документ
Так ли это на самом деле?
 
Цитата
Меня просто интересут что такое, так называемый "единый источник", знакомые технические писатели даже понятия не имеют об этом. Уменя представление такое:
1.Большая компания
2. Несколько технических писателей
3. Каждый пишет свой раздел
4. Из этих кусочков складывают объемный документ
Так ли это на самом деле?

На самом деле, не так.

Цитата
1.Большая компания

Физически компании может и не быть - возможна удаленная работа.

Цитата
2. Несколько технических писателей
Достаточно одного человека.

Цитата
3. Каждый пишет свой раздел
Всё может писать 1 человек.

Цитата

4. Из этих кусочков складывают объемный документ
Наконец-то верная догадка.

Если вы знакомы с реляционными базами данными, то основной принцип их создания - информация об объекте  должна храниться только в одном месте (и изменятьс(корректироваться) только в месте хранения).
Например,  ФИО сотрудников организации хранятся только в одной таблице, а во всех других таблицах (структура отделов, штатное расписание, ведомость зарплаты и т. п.) хранятся ссылки (указатели) на ФИО, а не сами ФИО.
Поэтому, если сотрудница А вышла замуж и поменяла фамилию, изменения вносятся только в одну таблицу - список ФИО, все остальные таблицы  остаются без изменения.
Примерно такой же идеологии  придерживается концепция единого источника - т. е. инфориация, используемая во многих документах, должна создаваться, храниться и корректироваться только в одном месте (неважно, одним человеком или десятью).
Примеры.
Фирма выпускает 100 модей мобильных телефонов и к ним соответствующую эксплуатационную документацию.
Модели отличаются друг от друга набором прибамбасов (функциональностью), при этом эксплуатационная документация на каждую модель на 80-90 % совпадает - описаие стандартных операций).
Вместо того чтобы  готовить 100 полнообъемных  эксплуатационных документо (в виде отдельных файлов). копируя в каждый из них  одинаковые тексты и в режиме правки внося описание новых функциональностей,  можно хранить набор готовых фрагментов (топиков), из которых путем сборки формируется описание соответствующей модели.
При необходтимости внесения  изменения, скажем, в стандартную операцию,    тест корректируется только в одном топике, а не во всех 100 файлах  эксплуатационных документов.

Аналогично и с ПО.
Если фирма занимается заказным конфигурированим ПО
(т. е. из готовых разработанных программных модулей собирает конкретную версию ПО под конкретные требования заказчика), то и документация тоже должна быть сконфигурирована под эти конкретные требования (что-то  добавлено, а что-то исключено - если заказчику эту функциональность не предоставляется).

Т. е. единый источник полезен тогда, когда необходимо разрабатывать много документации,  используя готовые (одинаковые) фрагменты.

Если же вы каждый раз  делаете совершенно новый проект и пишите для него совершенно новую документацию (работаете эсклюзивно), единый источник вам, имхо, как козе барабан.
 
Спасибо за ответ, Ю.В, теперь все более менее понятно стало.
 
А можно как то избежать проблемы нумерации? Если в одном документе топик нумеруется как 2.1 то в другом документе этот же топик должен иметь нумерацию 3.5 а в третьем например 5.2 Сам номер задается в title. Спасибо заранее
 
Цитата
А можно как то избежать проблемы нумерации? Если в одном документе топик нумеруется как 2.1 то в другом документе этот же топик должен иметь нумерацию 3.5 а в третьем например 5.2 Сам номер задается в title. Спасибо заранее

Если ваш софт поддерживает "условный вывод", то можно.
 
Зачем в title надо указывать номер?
 
топик должен иметь номер(4, 4.2, 2.1.1). там своеобразная иерархия. а как можно не прописывать в title номер перед названием, но чтобы в документе номер был перед названием?
 
Цитата
4, 4.2, 2.1.1). там своеобразная иерархия.
Так многие делают.
Цитата
а как можно не прописывать в title номер перед названием, но чтобы в документе номер был перед названием?
Это зависит от инструментов, которые вы используете. В большинстве, нумерация выполняется автоматически и она настраиваемая.
 
Это от хml редактора зависит? я использую XMLMind. Подскажите каким лучше пользоваться, и надо ли что - то еще. Спасибо
 
Не от редактора, а от паблишера - чем вы собираете конечный документ?

Если XMLMind сам же и собирает доки, значит у него должна быть авто-нумерация в настройках вывода.
 
С помощью XMLMind я только топики и  карты создаю, а дальше все в дите собирается, и если я не ошибаюсь то antом
 
Цитата
С помощью XMLMind я только топики и  карты создаю, а дальше все в дите собирается, и если я не ошибаюсь то antом
Угу. Нумерация создается с помощью шаблонов xslt.  Надо докрутить диту немного. При чем формат номера может быть какой угодно. Какая версия dita у вас?
 
версия 1.5.3
 
Предлагаю переместить этот вопрос в подфорум  Dita XML.

Writer, вы не могли бы переместить все сообщения Nata, начиная с

Цитата
А можно как то избежать проблемы нумерации? Если в одном документе топик нумеруется как 2.1 то в другом документе этот же топик должен иметь нумерацию 3.5 а в третьем например 5.2 Сам номер задается в title. Спасибо заранее
и поставить их перед существующими на данный момент в теме
viewtopic.php?f=47&t=1223&start=0   (Dita XML - Нумерация заголовков PDF)
Страницы: 1
Читают тему