Как писать техническую документацию?

Как писать техническую документацию? Ее содержимое - тексты? Как тексты техдокументации вообще, так и любые технические публикации, от журнальных статей до докторских диссертаций? Простые и эффективные способы, позволяющие писать тексты понятными, без применения каких-либо буржуйских технологий описания, удобочитаемыми и заведомо выдерживающими как самую жесткую и обоснованную критику, так и беспардонные, беспочвенные и технически не обоснованные заявления оппонентов. Редакция от 03.04.2021.

Создан 29.03.2014 16:37:21

- Как писать техническую документацию?

Существует множество нормативных документов, таких как ГОСТ 2.105, ГОСТ 19.106, ГОСТ 28195, ГОСТ 7.32, ГОСТ 8.417 и других основополагающих стандартов, регламентирующих требования к текстовым документам, к их структуре, содержанию, содержимому, построению, стилю изложения, оформлению, к критериям оценки качества, см. Качество технической документации, к сокращениям физических величин. Смысл и важность их применения детально расписаны в подразделе 6.1.3.1 книги Автоматизация разработки технической документации с применением AuthorIT. Учебное пособие.

Однако нормативно-технического документа, освещающего приемы и способы изложения технического текста в целом так, чтобы текст стал прозрачным и понимаемым, скорее всего не существует вообще. Но на самом деле эти приемы и способы предельно просты, до слез понятны и подробно расписаны на двух-трех страничках подраздела 6.1.7 той же книги.

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

Copyright © «Техническая документация» 2008-2021. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.

Яндекс.Метрика