Принцип обновления
Документация должна обновляться одновременно с изменением продукта, а не через неделю после него.
Как вносить изменения
Сначала обновите контент страницы в админке, затем проверьте якоря, структуру слева и смысловые ссылки внутри текста.
Когда создавать новую страницу
Новая страница нужна, если:
- сценарий стал слишком большим;
- появилась отдельная тема для самостоятельного использования;
- контент нужно передать другой ответственной команде.
Когда достаточно изменить текущую
Если меняется только порядок шагов, небольшая часть интерфейса или уточняется формулировка, лучше обновить существующую страницу без дробления.
Ответственность
Владелец раздела
У каждого раздела должен быть один ответственный редактор.
Ревью изменений
Перед публикацией крупных правок просматривайте, не сломались ли якоря и не появились ли пустые разделы справа.