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

По какому принципу делается любая пояснительная записка, какая информация там должна быть, где ее взять - было здесь. Теперь разберемся, как уложить добытую информацию в документ: как организовать структуру документа в зависимости от того, для какого объекта делается пояснительная записка. Для этого мы будем использовать требования Российских стандартов. Существует несколько систем ГОСТ, в которых приведены требования к пояснительным запискам: 1. Пояснительная записка программы делается в соответствии с единой системой программной документации (ГОСТ 19, ЕСПД)...