Команда > Авторские публикации > 2014 год > О красоте оформления документации

О красоте оформления документации

От беспорядка всякое дело шатко. 

Давайте поговорим об аккуратно и красиво оформленной договорной и проектной документации в области ИТ технологий. О том, как это важно и зачем это нужно...

 

 Что за порядок: огород без грядок.

 Работа огородная, да слава всенародная.

Договорная документация — это в первую очередь сам Договор. Создается этот документ юристами. Документ этот является    соглашением двух или нескольких сторон о взаимных правах и обязательствах. Стороны устанавливают порядок  взаимоотношений. Это начало работы. А в начале каждого дела очень важно показать уважение сторон. И если это уважение  выражено сухим и строгим Договором, то оформлению этого Договора совсем не помешает красота и аккуратность. И пусть в нем мало общего с самим программным обеспечением или системой, которые будут разрабатываться на основе Договора, но сам «жанр» этого документа просто призывает заботиться о внешнем виде. Чистописание и каллиграфия очень даже применимы к компьютерному набору текстов. Почему нет?

 

По платью встречают, по уму провожают.

Криво дерево, да яблоки сладки.

К договору часто прилагается Техническое задание. Этот документ содержит специфические технические требования к проекту, не вошедшие в Договор. Техническое задание создается менеджерами и аналитиками. А это уже люди, имеющие отношение к ИТ сфере. Описание специфики и технических требований сродни визитной карточке. А визитная карточка просто обязана быть строгой и... красивой. Как говорят кулинарные дамы: я потратила столько сил и времени на пирог, и не поленюсь измазать его яйцом для красоты. Для красоты! Если пирог получится красивым, то его сразу же захочется съесть.

«Визитная карточка» не просто не должна портить первое впечатление. Она должна это впечатление производить.

 

Где порядок, там удача.

Порядок бережет время — порядок дела не портит.

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

 

Изобретение — это вперед движение.

Кому до чего, а кузнецу до наковальни.

Каждая компания имеет свой фирменный стиль, который отличает ее от прочих компаний. Очень важно, чтобы документация выделялась среди документов других компаний. И выделялась выгодно! Один художник может сотворить картину, а другой художник сделает к ней раму. Особые «любители искусства» сначала обращают внимание на раму, если она их впечатляет — они начинают проникаться самим произведением, его содержанием и уникальностью, деталями, сюжетом, идеей.

Каждый проект уникален и содержателен. Оформлять документацию, безусловно, должны технические писатели. Это они профессионально создадут достойную «раму» тому или иному проекту. Это они помогут упростить и ускорить сложный процесс создания и оформления документации. Это они смогут придать документам профессиональный вид.

 

С уважением, Александра Соколова