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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Ряд вопросов по H&M, Вопросы по нумерованию разделов, репозиторию и сложным модульным проектам.
 
Предстоит выбор программы для создания документации в различных форматах (PDF, HTML, RTF).
Начал осваивать данную программу и возник вопросов.
Организация занимается выпуском специализированного оборудования с различным типоисполнением. Прибор состоит из ряда типовых модлуей: питание, ввод-вывод, межблочные соединения, индикация, клавиатура. Каждый из этих модулей имеет несколько вариантов исполнения: 10 входов и 5 выходов, 20 входов и 40 выходов. большой экран, маленький экран, большой корпус, маленький корпус и т.п. Для автоматизации создания документов к каждому типоисполнению решено попробовать применить подобную программу. Но столкнулся со следующими вопросами.
1. Итоговый документ должен состоять из отдельных кусков, каждый из которых может содержать в себе еще более мелкие части. Подобным образом собирается итоговый документ. Некоторые части (модули) могут представлять из себя отдельный абзац итогового текста. Можно ли как-то добавлять такие модули без нумерации? Например, есть абстрактный пункт 1.3 который должен содержать назначение прибора, допустимые условия эксплуатации и диапазон входных измеряемых величин. В зависимости от исполнения прибора содержание этих абзацев разное (делаю их как отдельные модули). Я делаю набор всех вариантов и применяю для конкретного прибора тот или иной абзац. Этот же абзац может применяться в других документах. Смысл в том, чтобы не править в каждом документе абзац, а поправить в одном месте. При этом, желательно не применять нумерацию (как в примере с Module A, Module B Modular help system).
2. Создание разделов без нумерации таких как "Аннотация", "Приложение А" и т.п. Например, Аннотация идет в самом начале. В программе выполнена отдельным модулем, но при публикации нумеровать надо со следующего раздела.
3. Создание сквозной нумерации или нумерации в пределах одного раздела рисунков (таблиц) в документе. Полагаю, что делать надо как-то через переменные. Для пораздельной нумерации как-то подцеплять номер раздела и порядковый номер рисунка в разделе.
4. Есть ли какой-то вариант внутрипрогаммного репозитория для быстрой работы с отдельными модулями? Может есть какая-нибудь надстройка? Или только один вариант с загрузкой модулей в проект фактически через виндовый проводник?
Изменено: Geonaft - 21.12.2016 16:48:27
 
Geonaft, отвечу по тому, что знаю:
1. Если правильно поняла, то Вам нужно использовать вставку сниппета со связью. Но для каждого абзаца надо создавать свой топик (Вы их вроде модулями называете), не включая его в содержание. Тут же ответ на вопрос 4: все топики лучше создавайте в едином проекте, не прибегая к внешнему репозиторию. Для этого в Project Explorer найдите Project Files > Topic Files и там из контекстного меню создавайте топик и в нем сохраните нужный абзац. Далее откройте топик, куда хотите вставить абзац, нажмите Insert Object > Snippet, выберите созданный ранее топик и установите переключатель Snippet is linked. В итоге абзац будет вставлен со связью. Но: почему-то в последней версии наблюдаются глюки в этом функционале: если топик содержит if-ы, то они так и остаются if-ами в пдфках.. В общем, суть в том, что HM - очень глючный продукт и я бы не советовала с ним связываться. Сделать можно многое, но реализация у них... через одно место.
2. Тут уже обсуждалась эта тема, если не ошибаюсь. Мне так и не удалось найти нормального решения, приходится делать нумерацию руками (к стыду и ужасу).
 
Внешний репозиторий крайне необходим. Т.к. с документацией будут  работать несколько человек. Соответственно, все наработки должны  храниться на сервере. Начал разбираться с SVN. На сколько я понимаю,  такой вариант вполне подойдет. По работе другими специалистами он уже  используется. Модулем я называю отдельный файл типа "Module_A.hmxz",  который может быть самодостаточным, содержать вложенные модули или быть  вложенным в другой модуль. Получается своеобразная матрешка из модулей.
tech_writer_1, как Вы делаете ручную нумерацию?
Изменено: Geonaft - 21.12.2016 20:22:36
 
Цитата
Geonaft написал:
Внешний репозиторий крайне необходим. Т.к. с документацией будут  работать несколько человек. Соответственно, все наработки должны  храниться на сервере. Начал разбираться с SVN. На сколько я понимаю,  такой вариант вполне подойдет. По работе другими специалистами он уже  используется. Модулем я называю отдельный файл типа "Module_A.hmxz",  который может быть самодостаточным, содержать вложенные модули или быть  вложенным в другой модуль. Получается своеобразная матрешка из модулей.
tech_writer_1 , как Вы делаете ручную нумерацию?
А, простите, я думала, вы с топиками работаете, с модулями не работала к сожалению...
Вручную - в содержании делаю Edit Caption и ввожу туда номера разделов.
 
могу только по п.3 сказать, что такую нумерацию делать можно. В их родном хелпе это все очень понятно описано.  
 
Еще раз спрошу по поводу автоматической нумерации разделов. Пока так и  не нашел способа как отдельные разделы не нумеровать или использовать  свой стиль нумерации.
Есть примерно такая структура документов на разные приборы:
Введение
Перечень принятых сокращений
1. Описание и работа
2. Использование по назначению
3. Техническое обслуживание
4. Транспортирование и хранение
Приложение А
Приложение Б
Количество  нумерованных разделов и приложений тоже может быть различным. Так же  после первоначального создания проекта разделы могут поменяться местами,  добавиться новые. Какой-то раздел (топик) может применяться в других  проектах и жесткая нумерация в названии топика не применима. Вариант  предложенный здесь  не подходит. Вариант с использованием сниппетов в PDF manual designer,  как я понял, тоже не подходит из-за ограничений на их размер.
Пробовал  вставлять переменные в названия топиков типа: "<%NUMBERING1%>  Описание и работа" и "Приложение <%ANUMBERING1%>". Такие  переменные есть только в PDF manual designer. Создаю свои переменные  "<%NUMBER1%> и <%ANUMBER%> со значениями 1 и А  соответственно. Вставляю их Topic header разных топиков. Но в итоге в  содержании ни чего нет. Что есть эти переменные что их нет.
Создание переменной для каждого топика по сути эквивалентно простому вбиванию номера раздела как и здесь.  Всю нумерацию Child topics получается тоже надо делать вручную.  Возможно есть варианты создания динамических переменных? Применение  переменной <%ANUMBERING1%> дает только английские буквы. Можно ли  сделать русскими буквами?
Как я уже писал выше проект может быть  вложенным в другие проекты. Например раздел "Транспортирование и  хранение" одинаков для разных приборов. Получится ли его сохранить в  виде сниппета или же придется делать отдельный проект пока не понятно.  Все зависит от возможности сохранения все структуры этого раздела с  картинками, таблицами и подпунктами.
Страницы: 1
Читают тему (гостей: 1)