13.01.2016  Экспертиза, Менеджмент

Грамотно составленная техническая документация — ахиллесова пята небольших проектов. Если крупная компания может позволить себе нанять сотрудников, которые на этом специализируются, то мелким это не по карману. Это чревато тем, что перспективные проекты оказываются невостребованными, поскольку пользователю сложно разобраться в тонкостях практической работы с ПО. Ещё в 2009 г. опытный технический писатель Боб Реселман написал статью, в которой изложил семь правил написания документации. Они актуальны до сих пор, свидетельство чему — приглашение автора на очередную конференцию Linux Expo, которая состоится в конце января в Калифорнии. Также подобное внимание говорит об изменении отношения к проектной документации вообще. Современные реалии сделали время, необходимое для освоения той или иной программы критическим фактором её использования. Если пользователь решит, что изучение займёт слишком много времени, то он, вероятнее всего, будет искать другое решение. Итак, семь правил Боба Реселмана, руководствуясь которыми не очень опытный человек может написать хорошую проектную документацию. 1. Избегайте сухости Это самое главное правило, которое, к сожалению, очень плохо формализуется. В современном информационном обществе создатели контента тратят много сил на привлечение внимания читателя. Скучный материал, вероятнее всего, никто читать не будет — люди уже привыкли, что их не учат, а развлекают. Поэтому даже технический текст должен быть написан так, чтобы его было интересно ... читать далее.