Инструкция нужна пользователям, которые ведут проектную документацию внутри CDP.
Работа с базой знаний
Инструкция описывает пользовательский порядок действий в интерфейсе CDP. Выполняйте шаги последовательно и проверяйте результат после каждого существенного действия.
Порядок действий
- Откройте проект и перейдите в База знаний.
- Нажмите создание страницы.
- Введите заголовок, краткое описание и основной текст.
- Разделите материал на понятные блоки: проблема, решение, проверка.
- Сохраните страницу.
- Используйте поиск, чтобы найти страницу позже.
- Обновляйте страницу при изменении процесса.
Что проверить после выполнения
- Название страницы понятно без открытия.
- В тексте есть конкретные шаги и результат проверки.
- Устаревшие сведения обновлены или удалены.
- Материал привязан к нужной сущности, если это поддерживается интерфейсом.
Типовые ошибки
- Называть страницы слишком общо: “Инструкция”, “Важно”, “Ошибка”.
- Хранить временные заметки без даты и контекста.
- Дублировать одну и ту же инструкцию в нескольких местах.