Справочник по техническим документам в ИТ: различия между версиями
WikiSysop (обсуждение | вклад) м (Изменил настройки защиты для «Справочник по техническим документам в ИТ» ([Редактирование=Разрешено только автоподтверждённым участникам] (бессрочно) [Переименование=Разрешено только автоподтверждённым участникам] (бессрочно))) |
|||
(не показано 38 промежуточных версий 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]]. | |||
* Добавлены статьи по терминологии КСАС, ЕСПД и ЕСКД. | |||
* Добавлены описания документов, предусмотренных [[Комплекс стандартов на автоматизированные системы|КСАС]] и [[Единая система программной документации|ЕСПД]], [[Единая система конструкторской документации|ЕСКД]] в части эксплуатационной документации. | * Добавлены описания документов, предусмотренных [[Комплекс стандартов на автоматизированные системы|КСАС]] и [[Единая система программной документации|ЕСПД]], [[Единая система конструкторской документации|ЕСКД]] в части эксплуатационной документации. | ||
= Над чем идет работа = | = Над чем идет работа = | ||
* Составляем список статей по негостовским документам, которые необходимо описать. | |||
* Добавляем статьи о [[Библиотечный каталог|книгах по документированию]]. | |||
* Составляем комментарии к статьям по гостовским документам и терминам. | * Составляем комментарии к статьям по гостовским документам и терминам. | ||
= Что в планах = | = Что в планах = | ||
* [[Предложенные статьи|Статьи, предложенные к написанию]]. | |||
* Распространенные документы, не предусмотренные гостами прямо (описание бизнес-процесса, руководство администратора, руководство по установке). | * Распространенные документы, не предусмотренные гостами прямо (описание бизнес-процесса, руководство администратора, руководство по установке). | ||
* Документы по управлению ИТ (например, план непрерывности бизнеса, план восстановления после аварии). | * Документы по управлению ИТ (например, план непрерывности бизнеса, план восстановления после аварии). | ||
Строка 12: | Строка 24: | ||
* Документы по информационной безопасности (например, описание модели угроз). | * Документы по информационной безопасности (например, описание модели угроз). | ||
* Организационно-распорядительные документы (положение о системе, различные регламенты). | * Организационно-распорядительные документы (положение о системе, различные регламенты). | ||
= Сотрудничество = | = Сотрудничество = | ||
Если вы чувствуете в себе силы участвовать в | Если вы чувствуете в себе силы участвовать в составлении или обсуждении статей этого справочника, напишите нам, пожалуйста, по адресу [mailto:editorial@gost34.ru editorial@gost34.ru]. Сообщите, какие именно темы вас интересуют, и расскажите немного о себе. |
Текущая версия от 03:40, 15 апреля 2024
Этот справочник по технической документации в области информационных технологий предназначен для широкого круга специалистов, включая технических писателей, бизнес- и системных аналитиков, архитекторов, а также руководителей проектов и ИТ-менеджеров. Он охватывает описания документов, предусмотренных национальными и международными стандартами, и тех, что выработаны практикой, предлагая цитаты из стандартов, их толкования, комментарии экспертов и сведения из опыта работы. Содержащиеся в справочнике терминологические и вспомогательные статьи призваны поддержать профессионалов в разработке и верстке технической документации. Инициатива носит некоммерческий характер и поддерживается сообществом специалистов в сфере технической документации.
Что уже сделано
- Все статьи по алфавиту.
- Добавлен профессиональный стандарт «Технический писатель».
- Добавлены статьи по терминологии ГОСТ Р ИСО/МЭК 12207—2010 и ГОСТ Р 57193—2016.
- Добавлены статьи по терминологии КСАС, ЕСПД и ЕСКД.
- Добавлены описания документов, предусмотренных КСАС и ЕСПД, ЕСКД в части эксплуатационной документации.
Над чем идет работа
- Составляем список статей по негостовским документам, которые необходимо описать.
- Добавляем статьи о книгах по документированию.
- Составляем комментарии к статьям по гостовским документам и терминам.
Что в планах
- Статьи, предложенные к написанию.
- Распространенные документы, не предусмотренные гостами прямо (описание бизнес-процесса, руководство администратора, руководство по установке).
- Документы по управлению ИТ (например, план непрерывности бизнеса, план восстановления после аварии).
- Документы по разработке систем с микросервисной архитектурой (архитектурная диаграмма, спецификация микросервиса, описание REST API).
- Основные виды диаграмм, применяемых в технической документации (диаграмма состояний, диаграмма взаимодействия и др.).
- Документы по информационной безопасности (например, описание модели угроз).
- Организационно-распорядительные документы (положение о системе, различные регламенты).
Сотрудничество
Если вы чувствуете в себе силы участвовать в составлении или обсуждении статей этого справочника, напишите нам, пожалуйста, по адресу editorial@gost34.ru. Сообщите, какие именно темы вас интересуют, и расскажите немного о себе.