Переквалификация в техписы. Нужна помощь

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ. ЕДИНАЯ СИСТЕМА КОНСТРУКТОРСКОЙ ДОКУМЕНТАЦИИ смотри в эту сторону и сюда ГОСТ 2.601-95 Эксплуатационные документы

спасибо за полезную информацию.
А в шаблоне там все учтено? а то вроде же и шрифт по гостам должен быть и прочее.

Про ГОСТ вам уже посоветовали, добавить нечего Я бы хотел позанудствовать и обратить ваше внимание на другую сторону профессии. Я все понимаю: форум, неформальное общение, спешка и т. п. Но... к русскому языку стоит относиться бережнее Если инструкция будет составлена на таком же русском, как и ваши посты на форуме, то заинтересовать начальство вряд ли получится. Если это начальство, конечно, вменяемое

Не совсем так Граммотность -- желательное, но не обязательное условие. Во-первых, как идеальный вариант, доки должен вычитывать корректор и\или научный редактор. Во-вторых, если, изучив доку, у пользователя (администратора, оператора, инженера по внедрению и т. п.) не остается никаких вопросов по использованию, администрированию продукта (после прочтения он садится и начинает работать с продуктом, не доставая техподдержку и т. п.), то на запятые и опенчатки мало кто станет обращать внимание.
Граммотность, в данном случае, превратится, скорее, в вопрос имиджа. У компании, которая хочет позиционировать себя, как ведущего игрока на рынке, все должно быть прекрасно. В том числе и прекрасные запятые на нужном месте. В этом случае, если техпис на самом деле пишет кайфовые доки, но допускает ошибки, уверен, что он останется на своем месте, а компания воспользуется вариантом за номером 1.
Ох что-то меня несет после работы, ой несет )) Прошу прощения )

Вот я за это двумя руками! Ну не может один человек написать книгу без единой ошибки!

сравнимых масштабов беда что и у _Alexandr_.
успела поработать и с чертежами и с различной документацией, но вот тех. писателем себя назвать все же не рискну. но потом поставили задачу сочинить документацию так, "чтобы и в пдф сохранить, и на сайт выложить, и анимация была". пробую подступиться к этому заданию. немного подумав, решила пользоваться xml-редактором и публикациями. и все вроде бы потихоньку помаленьку становится понятно, но вот такие задачи, как ,например, вставить формулу ставят в тупик.

да, изображениями тоже хороший вариант, но качество отображения хромает, конечно. попробовала написать формулу в редакторе MathML, и уже ее, формулы, код списывать в XML файл, подсмотрев примеры. для DocBook получилось, для DITA пока не очень.
Кстати, кто то может поделиться опытом, с чем мне лучше работать для решения поставленной задачи ("чтобы и в пдф сохранить, и на сайт выложить, и анимация была"), с DITA или DocBook?

Спасибо, буду осваивать DITA. Теперь у меня хотя бы направление действий есть.

Доброго времени ГОСТЬ! H&M достойный инструмент, но в отличии от DITA он лишен многопользовательского режима работы, для небольших компаний H&M  самое то. Если вы хороший специалист в этом направлении были бы очень рады вашим советам и рекомендациям на форуме Help Manual

А какие именно ссылки? (топик-линки, url, mail, js... )

Тогда понятно, откуда у Вас в топик-линках берется кириллица. Именуете Topic ID по-русски? Представляете, если одновременно несколько писателей работают с одним проектом в H&M, то какая каша получается? Ссылки идут по Topic ID, а они не должны быть на кириллице - гораздо проще их обозвать 1, 1.3.1 или Topic1-2, чтобы облегчить сборку комплексного или сетевого проекта и даже ради сохранения сортировки в списке Target при вставке линка. Кириллица же, при этом, используется только для именования самого топика - <TITLE> Tag. В тексте, при вставке ссылки на топик, в качестве Caption пишется не название главы, на которую ведет ссылка, а используется переменная <%TARGETTITLE%>. К примеру,

Топик на который будем ссылаться:
<Topic ID>: Topic3-1
<TITLE> Tag: Состав дистрибутива

Свойства ссылки на данный топик в тексте:
Caption: <%TARGETTITLE%>
Tooltip: Перейти к главе "<%TARGETTITLE%>"
Style: Link
Target: Topic3-1
Help file: (Current)
Window: (Same Window)

В результате вставки такого топик-линка, в тексте мы увидим: Состав дистрибутива
При щелчке левой кнопкой мыши - перейдем на нужную главу, а при наведении на нее - увидим подсказку "Перейти к главе "Состав дистрибутива".

Почему не использовать в Topic ID имя этого же файла, если в файле один topic ID?