Сегодня я расскажу вам об еще одном приятном техписовском приемчике

На уходящей неделе я работал с документом под названием «Пояснительная записка к техническому проекту».

Это стандартный многостраничный документ (в моем случае записка была ок. 90 страниц), у него типовое содержание, и по стандарту в начале документа, в разделе «Подтверждение соответствия проектных решений действующим нормам и правилам …» (или аналогичном) техпис должен перечислить эти самые нормы и правила, которые разработчики учитывали при разработке заказанной системы.

И вот техпис их перечисляет по очереди:

А потом, под этим разделом есть еще один раздел «Сведения об использованных при проектировании нормативно-технических документах» (или аналогичный) , который во многом дублирует уже упомянутый выше раздел. И вот эти все перечисления заняли в моем случае добрых 10 страниц, которые нормальный читатель вынужден перелистывать, не особо вчитываясь.

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

Оказывается, ГОСТ разрешает делать в этой «Пояснительной записке» раздел «Ссылочные документы» (что-то типа привычной многим из нас «Библиографии»), утащить эти списки документов туда, причем, можно выкинуть из обоих списков дубли (у меня это сократило документ почти на 4 страницы), и в самом тексте ссылаться на эти документы просто номерочками в квадратных скобках. Особо дотошный читатель, если захочет, всегда найдет все нужные документы и ссылки, а не очень дотошный просто пролистнет эти полстранички — всем удобно.

На экране скриншоты того, как это в итоге стало выглядеть у меня (разумеется, всю конфиденциальную инфу я вырезал) .

Надеюсь, будет полезно.