Внутренняя документация содержит информацию о том, как работает процесс ревью, руководства по стилю, графики, чек листы процесса релиза и т. д. Для разработчиков внутренняя документация может содержать детали об инструментах, используемых для разработки, о том как происходит процесс сборки, какие практики кодирования следует соблюдать, как передать сборку на тестирование в отдел тех контроля (QA) и т. д. Она также может включать инструкции по развертыванию или выпуску продукта.
Связанные термины
- Обучающая документацияОбучающая документация — это тип технической документации, который используется для предоставления инструкций и руководств для пользователей продукта. Иными словами, это специально организованные документы, основной целью которых является предоставление базовых навыков и опыта использования любого продукта или функционала. Так как мы...Читать далее
- Опросный листОпросный лист — это документ, в котором описываются и обобщаются характеристики производительности, а также технические параметры продукта, материала, компонента, оборудования или другого объекта. Структура опросного листа, как правило, включает введение, где раскрывается основная цель документа, а его содержание варьируется в...Читать далее
- Журнал изменений (Changelog)Журнал изменений (Changelog) — это документ, файл или раздел документации, в котором фиксируются все изменения, внесённые в продукт, систему или документ. Он показывает, какие обновления были сделаны, когда они произошли и в чём заключается суть изменений. Журнал изменений используется в...Читать далее
- Документация по безопасностиДокументация по безопасности — это совокупность документов, которые описывают, устанавливают и регламентируют требования, правила, меры и процедуры, направленные на обеспечение безопасности при разработке, эксплуатации и использовании продукта, системы или оборудования. Она помогает снижать риски, предотвращать инциденты и обеспечивать защиту пользователей,...Читать далее
- Документация для партнеровДокументация для партнёров — это набор материалов, которые описывают условия сотрудничества, правила интеграции и взаимодействия между компанией и внешними партнёрами. Она помогает выстроить единые процессы работы и снизить количество ошибок при подключении партнёрских решений. Такая документация используется в экосистемах, где...Читать далее
- Хостинг документацииХостинг документации — это способ размещения и публикации документации на сервере или платформе, чтобы она была доступна пользователям через интернет или внутреннюю сеть. Он определяет, где и как хранится и отображается документация. Такой подход используется для публикации пользовательской, технической и...Читать далее
Свежие статьи
- Лучшие способы создать корпоративную Wiki
- Система управления знаниями (KMS): как организовать и использовать знания внутри компании
- Ментальные карты онлайн: лучшие инструменты и сервисы для создания mindmap
- Интерактивная техническая документация: способы повышения вовлеченности читателя
- Матрица RACI в документации: кто отвечает, кто согласует и как избежать хаоса
Дайджест техписателя
Рассылка свежих статей для техписателей раз в месяц.
"*"обозначает обязательные поля
Словарь по управлению документацией и знаниями
Словарь от Документерры — самый полный список актуальных терминов, понятий, инструментов по организации, систематизации и управлению продуктовой документацией.
