38 lines
4.2 KiB
Markdown
38 lines
4.2 KiB
Markdown
---
|
||
title: "Этап\_4. Создание внутренней документации"
|
||
intro: 'Вы создаете внутреннюю документацию, а затем знакомите с ней потребителей {% data variables.product.prodname_GH_advanced_security %}.'
|
||
versions:
|
||
ghes: '*'
|
||
ghae: '*'
|
||
ghec: '*'
|
||
topics:
|
||
- Advanced Security
|
||
shortTitle: 4. Create internal documentation
|
||
miniTocMaxHeadingLevel: 3
|
||
ms.openlocfilehash: caf35f06c3f836ea7532b7c5e9dfb419ba8c325b
|
||
ms.sourcegitcommit: f638d569cd4f0dd6d0fb967818267992c0499110
|
||
ms.translationtype: MT
|
||
ms.contentlocale: ru-RU
|
||
ms.lasthandoff: 10/25/2022
|
||
ms.locfileid: '148109106'
|
||
---
|
||
{% note %}
|
||
|
||
Эта статья является частью серии "Внедрение {% data variables.product.prodname_GH_advanced_security %} в большом масштабе". Предыдущая статья этой серии: [Этап 3. Пилотные программы](/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs).
|
||
|
||
{% endnote %}
|
||
|
||
Перед включением {% data variables.product.prodname_GH_advanced_security %} необходимо создать внутреннюю документацию, которая будет определять процессы для команд. Все должны знать, что делать, когда они получают оповещение системы безопасности, даже если процесс просто просит команду принять максимально верное решение. Документация также предотвратит блокировку работы разработчиков при наличии вопросов. Необходимо поместить документацию по GHAS в существующую документацию, ориентированную на разработчиков, например на портал разработчиков или в собственную базу знаний.
|
||
|
||
Если вы запустили пилотные программы, используйте опыт и отзывы от команд, участвующих в них, чтобы скорректировать документацию. Это особенно полезно, если вы столкнулись с проблемами, специфичными для вашей компании, так как другие команды, скорее всего, тоже с ними столкнутся.
|
||
|
||
Если вы пропустите этап создания внутренней документации, развертывание не будет выполняться в нужном темпе. Создание внутренней документации может замедлить первоначальное развертывание на одну-две недели, но это время будет восполнено, когда разработчики смогут сами отвечать на свои вопросы, а не обращаться к вашей команде.
|
||
|
||
Обучение, вероятно, является наиболее важной частью развертывания, как оно учит разработчиков, что делать в различных ситуациях. Вы должны убедиться, что разработчики способны поддерживать безопасность своего репозитория, а группа безопасности уполномочена проверять как то, что делают разработчики, так и то, что это отвечает интересам безопасности. В дополнение к внутренней документации обучение может принимать форму онлайн-сессий, вопросов и ответов и т. д.
|
||
|
||
{% note %}
|
||
|
||
Следующая статья этой серии: [Этап 5. Развертывание и масштабирование проверки кода](/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning).
|
||
|
||
{% endnote %}
|