Справочник по техническим документам в ИТ

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

Что уже сделано

• Добавлены описания документов, предусмотренных КСАС и ЕСПД, ЕСКД в части эксплуатационной документации.
• Добавлены статьи по терминологии КСАС, ЕСПД и ЕСКД.

Над чем идет работа

• Составляем комментарии к статьям по гостовским документам и терминам.

Что в планах

• Распространенные документы, не предусмотренные гостами прямо (описание бизнес-процесса, руководство администратора, руководство по установке).
• Документы по управлению ИТ (например, план непрерывности бизнеса, план восстановления после аварии).
• Документы по разработке систем с микросервисной архитектурой (архитектурная диаграмма, спецификация микросервиса, описание REST API).
• Основные виды диаграмм, применяемых в технической документации (диаграмма состояний, диаграмма взаимодействия и др.).
• Документы по информационной безопасности (например, описание модели угроз).
• Организационно-распорядительные документы (положение о системе, различные регламенты).

Сотрудничество

Если вы чувствуете в себе силы участвовать в написании или обсуждении статей для этого справочника, напишите нам, пожалуйста, по адресу [editorial@gost34.ru editorial@gost34.ru]. Напишите, какие именно темы вас интересуют, и расскажите немного о себе.