Справочник по техническим документам в ИТ: различия между версиями

Материал из Гостопедии
Перейти к навигации Перейти к поиску
Метка: отменено
Метка: ручная отмена
Строка 1: Строка 1:
Этот справочник по технической документации в области информационных технологий предназначен для широкого круга специалистов, включая технических писателей, бизнес- и системных аналитиков, архитекторов, а также руководителей проектов и ИТ-менеджеров. Он охватывает описания документов, предусмотренных национальными и международными стандартами, и тех, что выработаны практикой, предлагая цитаты из стандартов, их толкования, комментарии экспертов и сведения из опыта работы. Содержащиеся в справочнике терминологические и вспомогательные статьи призваны поддержать профессионалов в разработке и верстке технической документации. Инициатива носит некоммерческий характер и поддерживается сообществом специалистов в сфере технической документации.
Этот справочник по технической документации в области информационных технологий предназначен для широкого круга специалистов, включая технических писателей, бизнес- и системных аналитиков, архитекторов, а также руководителей проектов и ИТ-менеджеров. Он охватывает описания документов, предусмотренных национальными и международными стандартами, и тех, что выработаны практикой, предлагая цитаты из стандартов, их толкования, комментарии экспертов и сведения из опыта работы. Содержащиеся в справочнике терминологические и вспомогательные статьи призваны поддержать профессионалов в разработке и верстке технической документации. Инициатива носит некоммерческий характер и поддерживается сообществом специалистов в сфере технической документации.
= Что уже сделано =  
= Что уже сделано =  
{|
|[[File:Microserv-cover-stamp.png|100px|link=Документирование микросервисных систем]]
|}


* [[Служебная:Все_страницы|Все статьи по алфавиту]].
* [[Служебная:Все_страницы|Все статьи по алфавиту]].

Версия от 23:10, 12 апреля 2024

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

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

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

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

Что в планах

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

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

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