Разработка технической документации, Руководство для технических писателей и локализаторов ПО, Глаголев В.А., 2008

Разработка технической документации, Руководство для технических писателей и локализаторов ПО, Глаголев В.А., 2008.

   Эта книга станет незаменимых помощником в работе технических писателей, специалистов по стандартизации и переводчиков-локализаторов программного обеспечения.
Издание посвящено вопросам разработки текстовой технической документации на аппаратно-программные комплексы, автоматизированные системы и программные продукты, к которым относится большая часть современного рынка высоких технологий. Приведены общие сведения о промышленной продукции и технической документации, основные понятия о государственной системе обеспечения единства измерений (ГСИ), единых системах конструкторской, программной и технологической документации (ЕСКД, ЕСПД и ЕСТД), комплексе стандартов на автоматизированные системы (КСАС). Рассмотрен жизненный цикл технической документация. Значительное место отведено вопросам разработки основных видов текстовой технической документации на аппаратно-программные комплексы и автоматизированные системы — технического задания, технических условий, программы и методики испытаний, а также эксплуатационной документации — руководства по эксплуатации, руководства пользователя, инструкции по эксплуатации, формуляра, паспорта, этикетки ведомости эксплуатационных документов. Изложены рекомендации по переводу, локализации, оформлению и приданию юридического статуса технической документации на продукцию зарубежных производителей. Рассмотрены основные программные инструменты, предназначенные для разработки текстовой технической документации.
Книга рассчитана как на получение начального образования молодыми специалистами, так и на углубление знаний опытных разработчиков текстовой технической документации. Будет представлял, интерес для переводчиков и редакторов переводов иноязычной технической документации.
К изданию прилагается компакт-диск с дополнительными материалами, которые могут оказаться полезными при разработке текстовой документации. В состав этих материалов включены нормативные документы, на которые даны ссылки в пособии, методические рекомендации по разработке и оформлению технической документации, а также шаблоны основных текстовых конструкторских документов.




Правила построения и изложения текста.
Правила построения и изложения текста в текстовом документе определяются требованиями ГОСТ 2.105-95. Единая система конструкторской документации. Общие требования к текстовым документам.

К основным положениям этого стандарта в части построения и изложения текста относятся следующие требования.

Текст документа при необходимости разделяют на разделы, подразделы, пункты и подпункты.

При большом объеме документа допускается разделять его на части, а части, в случае необходимости, на книги. Каждую часть и книгу комплектуют отдельно. Всем частям дают наименования и присваивают обозначение документа. Обозначение частей документа осуществляется согласно стандартам ЕСКД и КСАС.

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

ОГЛАВЛЕНИЕ.
Перечень аббревиатур и сокращений.
Введение.
1. Общие сведения о промышленной продукции технической документации.
2. Основные сведения о Государственной системе обеспечения единства измерений (ГСИ). Сертификация промышленной продукции.
3. Единая система конструкторской документации (ЕСКД) как базовая система стандартов для разработки ТД.
4. Единая система программной документации (ЕСПД) и ее применение при разработке ТД на АПК и АС.
5. Основные сведения о единой системе технологической документации (ЕСТД).
6. Жизненный цикл технической документации.
7. Разработка основных видов текстовой технической документации на АПК согласно требованиям ЕСКД.
8. Разработка основных видов текстовой технической документации на АС согласно требованиям КСАС.
9. Перевод, локализация, редактирование, придание юридического статуса и оформление переводов иностранной технической документации.
10. Основные программные инструменты, рекомендуемые для разработки текстовой технической документации.
Принцип «единого источника» при создании связанных документов.
Заключение.

Купить .





Теги: учебник по информатике :: информатика :: компьютеры :: Глаголев