Trupeer Blog
Резюмировать
Обновление ServiceNow запланировано на следующий месяц. Команде платформы нужно понимать, какие бизнес-правила, сценарии и клиентские скрипты могут быть затронуты, аудиторам требуется подтверждение того, кто может одобрять изменения, а новый администратор только что присоединился. Все обращаются к документации и находят дизайн-документ с момента запуска, папку со скриншотами, которые больше не соответствуют экранам, и множество знаний, которые существуют только в голове одного консультанта.
Документация по внедрению ServiceNow предотвращает это. Она фиксирует, что было создано, почему и как настроено, а также как люди этим пользуются — чтобы платформу можно было безопасно обновлять, проходить аудит и расширять. Это руководство объясняет, что должна включать документация по внедрению ServiceNow, как документировать рабочие процессы без ручных скриншотов, как фиксировать настройки для аудита, что документировать на каждом этапе и как поддерживать актуальность на протяжении регулярных релизов ServiceNow.
Что такое документация по внедрению ServiceNow?
Документация по внедрению ServiceNow — это набор записей, которые объясняют внедрение ServiceNow: требования и проектирование процесса, настройку экземпляра, конфигурацию и кастомизацию, интеграции, решения по данным и CMDB, тестирование, релизы, а также руководства, которые подсказывают агентам, сотрудникам и администраторам, как пользоваться и запускать платформу. Она применяется к ITSM и к другим рабочим процессам ServiceNow, например к доставке HR-услуг или клиентскому сервису.
Те же принципы применимы и к другим корпоративным платформам; см. как документировать сложные процессы корпоративного ПО в SAP, ServiceNow и Salesforce.
Почему важна документация по внедрению ServiceNow?
Обновления безопаснее. ServiceNow выпускает новые версии два раза в год, а задокументированные кастомизации помогают понять, что нужно тестировать.
Аудиты проще. Аудиторам нужны доказательства конфигураций, настроек доступа и одобрений изменений.
Смена администраторов менее рискованна. Причины каждой настройки не исчезают вместе с человеком, который ее создавал.
Изменения выполняются быстрее. Командам не нужно «воссоздавать» бизнес-правило перед тем, как его изменить.
Повышается вовлеченность. Агенты и сотрудники с понятными руководствами используют платформу так, как она была задумана.
Что должна включать документация по внедрению ServiceNow?

Документ | Что он охватывает |
|---|---|
Требования и проектирование процесса | ITSM-процессы, такие как инциденты, запросы, проблемы и изменения, а также решения, лежащие в их основе |
Ландшафт экземпляров | Разработка, тест и продуктив, а также то, как изменения перемещаются между ними |
Журнал конфигурации | Таблицы, поля, формы, бизнес-правила, клиентские скрипты, UI-политики, сценарии и уведомления — с указанием цели и владельца |
Доступ и безопасность | Роли, группы, настройки доступа и права на одобрение |
Сервисный каталог | Позиции каталога, переменные, рабочие процессы и группы выполнения |
Интеграции | Подключенные системы, потоки данных, владение учетными данными и обработка ошибок |
CMDB и данные | Область CMDB, источники данных, владение и правила качества данных |
Релизы и записи об изменениях | Что содержал каждый релиз и как он был одобрен |
Тестирование | Тестовые скрипты, результаты и автоматизированные тесты |
Руководства для пользователей и агентов | Пошаговые руководства и видео для агентов, лиц, одобряющих, и сотрудников |
Runbook’и администратора | Регулярные задачи, такие как администрирование пользователей, clone-downs и подготовка к обновлению |
Как документировать рабочие процессы ServiceNow без ручных скриншотов?

Ручные скриншоты — самый медленный способ документировать ServiceNow. Каждый шаг означает: сделать снимок, обрезать, вставить и снабдить комментариями, а любое изменение интерфейса делает скриншоты устаревшими. Подход «сначала запись» быстрее и проще в поддержке:
Запишите рабочий процесс один раз, выполняя его в своем экземпляре и параллельно проговаривая каждый шаг, с AI screen recorder от Trupeer.
Автоматически сгенерируйте руководство. Trupeer превращает запись в пошаговое руководство с захваченными скриншотами и озвученным видео.
Отредактируйте и добавьте контекст, например бизнес-правила, критерии одобрения и что произойдет дальше.
Опубликуйте там, где люди ищут информацию, в вашей базе знаний или портале.
Обновляйте правками, а не повторной записью, когда меняется метка или шаг.
Это работает и для рабочих процессов агентов, запросов из каталога, одобрений и админ-задач. Для статей базы знаний в частности см. лучшие практики ServiceNow для knowledge article.
Как документировать конфигурации ServiceNow для аудита?

Аудиторам и командам по управлению платформой нужно видеть, что настроено, кто может это изменить и как одобряются изменения. Чтобы документировать конфигурации ServiceNow для аудита:
Ведите журнал конфигурации для каждой кастомизации: цель, владелец, дата и требование, которое она закрывает.
Фиксируйте walkthrough’и критически важных конфигураций, например правил одобрения, настроек доступа и рабочих процессов изменений, показывая, как они работают в экземпляре.
Документируйте роли и доступ по группам, с бизнес-обоснованием для привилегированных ролей.
Привязывайте каждое изменение к его одобрению, через ваши записи об изменениях и релизах.
Версионируйте документацию, чтобы вы могли показать, как выглядела конфигурация в любой момент; см. SOP version control.
Регулярно проводите проверку, особенно перед аудитами и после обновлений.
Что следует документировать на каждом этапе внедрения?

Этап | Что документировать |
|---|---|
Discovery | Текущие процессы, болевые точки, требования и объемы, которые платформа должна обрабатывать |
Design | Проектирование процесса, модель данных, дизайн каталога, модель безопасности и дизайн интеграций — с обоснованиями |
Build | Журнал конфигурации, скрипты и сценарии, детали интеграций, записанные walkthrough’и сложной логики |
Test | Тестовые скрипты, результаты, дефекты и подтверждение готовности |
Deploy | Содержимое релиза, шаги развертывания, загрузки данных и планы отката |
Hypercare и run | Проблемы и исправления, FAQ, обновленные руководства и передача команде сопровождения |
Для доказательств тестирования см. чек-лист документации UAT.
Как создать документацию по внедрению ServiceNow пошагово?

Шаг 1: Согласуйте стандарт документации
Определите, какие документы вам нужны, шаблон для каждого, где они будут храниться и кто за них отвечает, прежде чем начнется сборка.
Шаг 2: Фиксируйте решения по мере проектирования
Записывайте проектные решения: какие варианты рассматривались и почему был выбран один из них. Именно логика — то, что будущим администраторам нужно больше всего.
Шаг 3: Ведите журнал конфигурации по мере сборки
Добавляйте каждую кастомизацию в журнал конфигурации сразу по мере ее создания, а не в конце проекта.
Шаг 4: Записывайте walkthrough’и процессов и конфигураций
Запишите, как администраторы объясняют сложные сценарии и правила, а ключевые пользователи выполняют задачи агентов и сотрудников, затем превратите записи в руководства и видео.

Шаг 5: Создайте руководства для каждой аудитории
Создайте отдельные руководства для агентов, лиц, одобряющих, сотрудников и администраторов. Обучение и документация для агентов должны идти рука об руку; см. лучшие практики ServiceNow для training video.

Шаг 6: Передайте с владельцами и датами проверок
По завершении проекта назначьте владельца для каждого документа и согласуйте, как документация будет обновляться с каждым релизом.
Как поддерживать актуальность документации ServiceNow при обновлениях?

Проверяйте документацию в рамках каждого обновления, вместе с пропущенными записями и регрессионным тестированием.
Привязывайте обновления документации к записям об изменениях, чтобы ни одно изменение не закрывалось без обновления документации.
Обновляйте руководства правками скриптов вместо повторной записи; см. как обновить training video без повторной записи.
Выводите документацию из использования для конфигураций, которые были удалены.
Сверяйте руководства с текущим интерфейсом после каждого релиза, особенно для сотрудников и агентов.
Подходит ли тот же подход для других ITSM-платформ?
Да. Независимо от того, используете ли вы ServiceNow, Atomicwork, Freshservice или другой инструмент ITSM, принципы те же: документируйте решения и конфигурации, фиксируйте walkthrough’и вместо того, чтобы вручную делать скриншоты, назначайте владельца каждому документу и обновляйте документацию при каждом изменении. Отличаются только терминология и экраны. Для сравнения «бок о бок» см. сравнение документации платформ ITSM.
Чек-лист документации по внедрению ServiceNow
Требования и проектирование процессов задокументированы с указанием причин ключевых решений.
Задокументированы ландшафт экземпляров и процесс продвижения.
Журнал конфигурации охватывает каждую кастомизацию — с целью и владельцем.
Задокументированы и обоснованы роли, группы и настройки доступа.
Задокументированы позиции каталога, интеграции и решения по CMDB.
Доказательства тестирования и записи релизов хранятся и связаны.
Опубликованы руководства для агентов, лиц, одобряющих, сотрудников и администраторов.
У каждого документа есть владелец и дата проверки.
Документацию проверяют в рамках каждого обновления и каждого изменения.
Частые ошибки в документации ServiceNow
Документируют «что», а не «почему», поэтому никто не знает, имеет ли кастомизация по-прежнему значение.
Опираются на ручные скриншоты, которые устаревают с каждым релизом.
Оставляют документацию на потом — после go-live.
Хранят документы в проектных папках, куда никто не заглядывает после передачи.
Игнорируют руководства для конечных пользователей и агентов, что снижает вовлеченность; см. нашу ServiceNow user adoption strategy.
Никогда не обновляют документацию после обновлений.
Создайте документацию по внедрению ServiceNow с Trupeer

Trupeer превращает записи вашего экземпляра ServiceNow в пошаговые руководства и видео, поэтому walkthrough’и конфигураций, рабочие процессы агентов и инструкции для сотрудников документируются без ручных скриншотов и остаются актуальными после каждого обновления. Ознакомьтесь с IT knowledge base и SOP platform от Trupeer или начните бесплатно с Trupeer.
Часто задаваемые вопросы
Что такое документация по внедрению ServiceNow?
Это набор записей, которые объясняют внедрение ServiceNow: требования, проектирование процесса, настройку экземпляра, конфигурацию, доступ, каталог, интеграции, CMDB, тестирование, релизы, а также руководства для агентов, сотрудников и администраторов.
Что должно быть включено в документацию ServiceNow?
Требования и проектирование процесса, ландшафт экземпляров, журнал конфигурации, роли и доступ, позиции каталога, интеграции, решения по CMDB и данным, записи релизов и тестов, руководства для пользователей и агентов, а также runbook’и администратора.
Как документировать рабочие процессы ServiceNow без скриншотов?
Запишите рабочий процесс один раз в своем экземпляре, проговаривая его, и используйте инструмент вроде Trupeer, чтобы превратить запись в пошаговое руководство с захваченными скриншотами и видео, затем обновляйте его правками, а не повторной записью.
Как документировать конфигурации ServiceNow для аудита?
Ведите журнал конфигурации с целью, владельцем и датой для каждой кастомизации, фиксируйте walkthrough’и критически важных конфигураций, документируйте роли и доступ, привязывайте изменения к одобрениям и версионируйте документацию.
Как часто нужно обновлять документацию ServiceNow?
При каждом изменении, которое на нее влияет, и в рамках каждого обновления, поскольку ServiceNow выпускает новые версии два раза в год.
Кто должен владеть документацией ServiceNow?
Владельцем библиотеки должна быть команда владельца платформы или администраторов ServiceNow, с назначенными владельцами для каждой области процессов и каждого руководства.
В чем разница между документацией администратора и руководствами для пользователей?
Админ-документация объясняет, как платформа построена и поддерживается. Руководства для пользователей объясняют, как агенты, лица, одобряющие, и сотрудники выполняют свои задачи. И то, и другое входит в документацию по внедрению ServiceNow.
Подходит ли этот подход для Atomicwork или Freshservice?
Да. Принципы те же для любой ITSM-платформы; меняются только терминология и экраны.
Frequently Asked Questions
What is ServiceNow implementation documentation?
What should be included in ServiceNow documentation?
How do you document ServiceNow workflows without screenshots?
How do you document ServiceNow configurations for audit?
How often should ServiceNow documentation be updated?
Who should own ServiceNow documentation?
What's the difference between admin documentation and user guides?
Does this approach work for Atomicwork or Freshservice?

