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

Материал из Гостопедии
Перейти к навигации Перейти к поиску
Нет описания правки
м (Изменил настройки защиты для «Справочник по техническим документам в ИТ» ([Редактирование=Разрешено только автоподтверждённым участникам] (бессрочно) [Переименование=Разрешено только автоподтверждённым участникам] (бессрочно)))
 
(не показано 48 промежуточных версий 2 участников)
Строка 1: Строка 1:
В эпоху информационных технологий качество технической документации играет ключевую роль в успехе любого проекта. Техническая документация не только служит мостом между разработчиками и пользователями, но и обеспечивает непрерывность знаний, помогая командам эффективно управлять проектами и поддерживать продукты. Понимание того, как создавать, структурировать и поддерживать документацию в соответствии с лучшими практиками и стандартами, становится необходимым условием для профессионалов в сфере ИТ.
[[File:Eskd-cover-stamp.png|200px|link=Документирование изделий]][[File:Espd-cover-stamp.png|200px|link=Документирование программных средств]][[File:As-cover-stamp.png|200px|link=Документирование автоматизированных систем]][[File:Microserv-cover-stamp.png|200px|link=Документирование микросервисных систем]][[File:It-cover-stamp.png|200px|link=Документирование ИТ-инфраструктур]][[File:Infosec-cover.png|200px|link=Информационная безопасность]][[File:Infotypes-cover-stamp.png|200px|link=Разделы и информационные типы]][[File:style-cover-stamp.png|200px|link=Стиль изложения]][[File:Flowcharts-cover-stamp.png|200px|link=Схемы, диаграммы, скриншоты]][[File:terminology-cover-stamp.png|200px|link=Управление терминологией]][[File:I18n-cover-stamp.png|200px|link=Интернационализация и локализация]][[File:docsascode-cover-stamp.png|200px|link=Документация как код]][[File:Dita-cover-stamp.png|200px|link=Структурированный контент]][[File:Tehpis-cover-stamp.png|200px|link=Технический писатель (профессия)]][[File:Libcat-cover-stamp.png|200px|link=Библиотечный каталог]][[File:misc-cover-stamp.png|200px|link=Все остальное]]
<hr>
Этот справочник по технической документации в области информационных технологий предназначен для широкого круга специалистов, включая технических писателей, бизнес- и системных аналитиков, архитекторов, а также руководителей проектов и ИТ-менеджеров. Он охватывает описания документов, предусмотренных национальными и международными стандартами, и тех, что выработаны практикой, предлагая цитаты из стандартов, их толкования, комментарии экспертов и сведения из опыта работы. Содержащиеся в справочнике терминологические и вспомогательные статьи призваны поддержать профессионалов в разработке и верстке технической документации. Инициатива носит некоммерческий характер и поддерживается сообществом специалистов в сфере технической документации.
= Что уже сделано =


Этот справочник предназначен для широкого круга специалистов, занимающихся разработкой и заказом технической документации в сфере информационных технологий. Он станет незаменимым ресурсом для технических писателей, бизнес- и системных аналитиков, архитекторов программного обеспечения и многих других, кто ежедневно сталкивается с задачами создания и управления техническими документами. Руководители проектов, ИТ-менеджеры, владельцы продуктов и заказчики ИТ-решений обнаружат в нем полезные знания о том, как качественная техническая документация может способствовать успеху их проектов.
* [[Служебная:Все_страницы|Все статьи по алфавиту]].
* Добавлен профессиональный стандарт [[Технический писатель (профессия)|«Технический писатель»]].
* Добавлены статьи по терминологии [[ГОСТ Р ИСО/МЭК 12207—2010. Процессы жизненного цикла программных средств|ГОСТ Р ИСО/МЭК 12207—2010]] и [[ГОСТ Р 57193—2016. Процессы жизненного цикла систем|ГОСТ Р 57193—2016]].
* Добавлены статьи по терминологии КСАС, ЕСПД и ЕСКД.
* Добавлены описания документов, предусмотренных [[Комплекс стандартов на автоматизированные системы|КСАС]] и [[Единая система программной документации|ЕСПД]], [[Единая система конструкторской документации|ЕСКД]] в части эксплуатационной документации.


В справочнике собраны описания различных видов документации, предусмотренных национальными и международными стандартами, а также тех, что выработаны профессиональным сообществом вне формальных стандартов, но зачастую используются на практике. Материал дополняется цитатами из стандартов, их толкованиями, комментариями специалистов и сведениями, накопленными в процессе реальных проектов. Такой подход позволяет не только глубже понять существующие нормы, но и узнать о живых примерах их применения, что особенно ценно для практиков.
= Над чем идет работа =
* Составляем список статей по негостовским документам, которые необходимо описать.  
* Добавляем статьи о [[Библиотечный каталог|книгах по документированию]].
* Составляем комментарии к статьям по гостовским документам и терминам.


Кроме того, справочник включает в себя терминологические статьи и руководства по инструментам разработки технической документации, верстки и решению других смежных задач. Он создан и поддерживается профессиональным сообществом разработчиков технической документации и представляет собой некоммерческий ресурс, цель которого &mdash; распространение знаний и опыта среди специалистов в области.
= Что в планах =
 
* [[Предложенные статьи|Статьи, предложенные к написанию]].
* Распространенные документы, не предусмотренные гостами прямо (описание бизнес-процесса, руководство администратора, руководство по установке).
* Документы по управлению ИТ (например, план непрерывности бизнеса, план восстановления после аварии).
* Документы по разработке систем с микросервисной архитектурой (архитектурная диаграмма, спецификация микросервиса, описание REST API).
* Основные виды диаграмм, применяемых в технической документации (диаграмма состояний, диаграмма взаимодействия и др.).
* Документы по информационной безопасности (например, описание модели угроз).
* Организационно-распорядительные документы (положение о системе, различные регламенты).
 
= Сотрудничество =
Если вы чувствуете в себе силы участвовать в составлении или обсуждении статей этого справочника, напишите нам, пожалуйста, по адресу [mailto:editorial@gost34.ru editorial@gost34.ru]. Сообщите, какие именно темы вас интересуют, и расскажите немного о себе.

Текущая версия от 03:40, 15 апреля 2024

Eskd-cover-stamp.pngEspd-cover-stamp.pngAs-cover-stamp.pngMicroserv-cover-stamp.pngIt-cover-stamp.pngInfosec-cover.pngInfotypes-cover-stamp.pngStyle-cover-stamp.pngFlowcharts-cover-stamp.pngTerminology-cover-stamp.pngI18n-cover-stamp.pngDocsascode-cover-stamp.pngDita-cover-stamp.pngTehpis-cover-stamp.pngLibcat-cover-stamp.pngMisc-cover-stamp.png

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

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

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

  • Составляем список статей по негостовским документам, которые необходимо описать.
  • Добавляем статьи о книгах по документированию.
  • Составляем комментарии к статьям по гостовским документам и терминам.

Что в планах

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

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

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

Источник — http://gost34.ru/index.php?title=Справочник_по_техническим_документам_в_ИТ&oldid=4231