Профессия "Технический писатель", или "Рыцари клавиатуры" | страница 52
К документам для внутреннего использования относятся:
• любые описания и комментарии к программному коду и базам данных;
• рабочие регламенты и бухгалтерские документы (например, штатное расписание);
• ролевая документация для различных сотрудников (не путать с ролевой документацией для клиентов);
• любые отчёты по деятельности компании, кроме создаваемых специально для публикации в открытых источниках.
Тексты этой категории могут публиковаться где угодно и уследить за их распространением невозможно, да это и не требуется. В них вы имеете право излагать ту информацию, которая может быть рассказана буквально всём и каждому. Это связано с тем, что эти тексты могут попасть (больше того, обязательно попадут) к вашим конкурентам. Если они, конечно, следят за вашей деятельностью, что является обычным элементом конкурентной борьбы.
В подобных документах вы можете рассказывать о продуктах компании или данные только о тех исследованиях, которые никоим образом не раскрывают технологические секреты компании, её маркетинговые приёмы и бизнес-стратегии. Эти документы вы будете априори писать для посторонних и важно точно оценивать, что является необходимым знанием для пользователя (например, функционал антивируса или информация о новой рекламной акции), а что (например, описание реализации антивирусного функционала) — лишней информацией, которая может быть использована «против вас».
Это как раз тот случай, когда немного здоровой паранойи не помешает — она убережёт вас от излишне полного (да-да, и такое бывает!) описания продукта.
К документам общего пользования относятся:
• руководства пользователя, администратора;
• ролевая документация для сотрудников компании-клиента (например, руководство оператора программы для внесения сведений о продукции на складе);
• обзоры и аналитика, рассчитанная на широкий круг лиц;
• пресс-релизы и вся PR-продукция компании.
Это наиболее распространённые тексты, с которыми приходится работать, на них приходится до 90% всех документов, выпускаемых компанией.
Сюда относятся документы, написанные в полном соответствии с каким-либо государственным стандартом (ГОСТом) и предназначенные для сдачи в различные государственные органы при приёмке описываемого изделия или программы в эксплуатацию. Как следствие, это в первую очередь техническая документация, которая может содержать те или иные подробности о конструкции разрабатываемого устройства.