Что такое техническая документация

Итак, мы уже поговорили о том, для чего нужна техническая документация. Теперь давайте поймём, что же это такое. Если за ответом на этот вопрос обратиться к ныне столь популярной википедии (wikipedia – ru.wikipedia.org.), то мы получим следующий вполне конкретный ответ: «Техническая документация – набор документов, используемых при проектировании (конструировании), создании (изготовлении) и использовании (эксплуатации) каких-либо технических объектов: зданий, сооружений, промышленных товаров, программного и аппаратного обеспечения.» Другими словами, к технической документации относится довольно обширный круг документов.

Разумеется, не всё из перечисленного в определении нас интересует. Наибольшее внимание стоит уделить пункту «программное и аппаратное обеспечение». То есть собственно то, с чем работает каждый системный администратор.

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

Соблюдение всех норм и правил необходимо в тех случаях, когда пакет технической документации готовится для внешнего пользователя. Например, если вы планируете продать (как вариант, перепродать) сетевую инфраструктуру вашей компании при смене офиса. Здесь вам на помощь как раз придут ЕСКД (Единая структура конструкторской документации) и ЕСПД (Единая система программной документации), а также прочие стандарты, принятые в таких случаях. Но это отдельный длинный разговор, и пока что мы об этом умолчим.

Когда начинать вести документацию