Профессия "Технический писатель", или "Рыцари клавиатуры"

Как следствие, лицо, ответственное за хранение и организацию доступа к таким документам, должно быть предельно внимательным: каждый сотрудник должен иметь доступ исключительно к тем документам, которые касаются лично его. Разработчики — к схемам БД, описанию кода, экономисты и финансисты — к данным о финансовом планировании и экономических показателях компании, бухгалтерия — к отчётам и правилам формирования премий и зарплаты. Если подобное разграничение не ввести и свалить всё в одну большую кучу — результат может быть плачевным. Например, младший секретарь Петя пороется в бумагах и увидит, что у старшего программиста Васи зарплата впятеро больше чем у него, и в состоянии обиженных чувств унесёт все до чего сможет дотянуться и опубликует всюду, на что фантазии хватит. Сотрудника, который организовал такое «общее» хранилище данных, бить будут долго и, возможно, ногами, но вред уже будет причинён.

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

Если же вы в одном документе смешали техническую, экономическую информацию и, к примеру, бизнес-планирование с расчетами, то шанс получить по лицу в случае утечки примерно равен ста процентам.

Поясним на примере: вы пишете внутреннюю документацию для программы Skype в тот момент, когда она только разрабатывается.

Первый текст для экономистов: анализируете рынок существующего ПО для обмена мгновенными сообщениями с функцией видеочата, делаете вывод, что такой программы нет и она будет востребована. Предлагаете некие маркетинговые ходы: бесплатные основные функции, плата за звонки и т. д. Производите расчёты прибыли и всё это несёте в виде отчёта к начальнику экономистов, чтобы обосновать разработку экономически.

Руководство согласно, надо писать программу.

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

Естественно, приведённая схема упрощена до невозможности, но суть задачи по распределение текстов внутри компании она передаёт верно.

К документам для внутреннего использования относятся:

• любые описания и комментарии к программному коду и базам данных;

• рабочие регламенты и бухгалтерские документы (например, штатное расписание);

• ролевая документация для различных сотрудников (не путать с ролевой документацией для клиентов);

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

Документы общего пользования

 Тексты этой категории могут публиковаться где угодно и уследить за их распространением невозможно, да это и не требуется. В них вы имеете право излагать ту информацию, которая может быть рассказана буквально всём и каждому. Это связано с тем, что эти тексты могут попасть (больше того, обязательно попадут) к вашим конкурентам. Если они, конечно, следят за вашей деятельностью, что является обычным элементом конкурентной борьбы.

В подобных документах вы можете рассказывать о продуктах компании или данные только о тех исследованиях, которые никоим образом не раскрывают технологические секреты компании, её маркетинговые приёмы и бизнес-стратегии. Эти документы вы будете априори писать для посторонних и важно точно оценивать, что является необходимым знанием для пользователя (например, функционал антивируса или информация о новой рекламной акции), а что (например, описание реализации антивирусного функционала) — лишней информацией, которая может быть использована «против вас».

Это как раз тот случай, когда немного здоровой паранойи не помешает — она убережёт вас от излишне полного (да-да, и такое бывает!) описания продукта.

К документам общего пользования относятся:

• руководства пользователя, администратора;

• ролевая документация для сотрудников компании-клиента (например, руководство оператора программы для внесения сведений о продукции на складе);

• обзоры и аналитика, рассчитанная на широкий круг лиц;

• пресс-релизы и вся PR-продукция компании.

Это наиболее распространённые тексты, с которыми приходится работать, на них приходится до 90% всех документов, выпускаемых компанией.

Документы для сдачи в принимающие государственные органы