Улучшаем качество документов, или простые правила управления бумагой

Привет! Меня зовут Данила, и я занимаюсь менеджментом, рисками и всем тем, что называют бумажной безопасностью. В этой статье под документом я буду понимать любой разрабатываемый материал, имеющий текст (протоколы, нормативные документы, презентации, white paper’ы и т.д.)

Поговорим о проблеме

На днях я читал положение, которое нам прислали консультанты. Документ оказался откровенно плохим; у меня набралось порядка 70 комментариев на 5 страниц сухого текста. Все плохо, задумался я; а еще задался вопросом: а что отличает хорошее управление документом от плохого вне зависимости от того, кто этот документ пишет?

Я попытался поискать в Интернете ответы, но особо ничего не нашел. Разрозненные статьи с разрозненными правилами; единого стандарта нет.

Значит попробую сформулировать критерии сам. Что выделяет хороший документ

• с ним ознакомлены все заинтересованные стороны;

• все знают где он лежит;

• все знают у кого можно получить комментарии по поводу его положений;

• легко читается;

• легко воспринимается;

• имеет четкую структуру;

• его можно выполнить;

• он отражает реальность;

• на него можно повлиять.

Все эти критерии можно сложить в 4 принципа:

• Прозрачность и доверие;

• Адаптация под читателя;

• Реалистичность и достижимость;

• Обратная связь.

4 принципа формируют концепцию ПАРО (по первым буквам).

Поговорим о концепции ПАРО подробнее

Я постараюсь описать каждый принцип и практики, которые можно применять для его выполнения.

Прозрачность и доверие

Отсутствие прозрачности документа может вызвать проблемы с информированием лиц, на которых он распространяется. Это, в свою очередь, повлечет несоблюдение требований, ошибочные управленческие решения и рост рисков.

Кроме того, недостаточная ясность снизит доверие к документу и ухудшит коммуникацию между заинтересованными сторонами, уменьшив ее эффективность.

Практики:

1. Указывайте авторов. Важно чтобы заинтересованные лица могли обратиться к автору за разъяснениями.

2. Указывайте версионность документа. Важно чтобы все заинтересованные лица использовали одинаковый документ.

3. Фиксируйте изменения в новых версиях. Кратко укажите какие изменения произошли, это ускорит ознакомление с новой версией документа.

4. Используйте современные форматы документов. Используйте такие форматы как .docx или .pdf. Старые форматы могут открываться некорректно.

5. Обеспечьте доступность документа. Все заинтересованные стороны должны иметь доступ к документу.

6. Зафиксируйте четкую цель разработки документа. Самое худшее что вы можете сделать — разработать “документ ради документа”. У него в обязательном порядке должна быть цель.

7. Зафиксируйте все источники информации. Важно обеспечить доверие к тем данным, которые вы используете.

Адаптация под читателя

Крайне важно осознавать: всё, что мы пишем, предназначено для читателя. Если ваш документ вызывает у него трудности с пониманием — вы не выполнили свою задачу. Помните: качественная документация должна быть понятна даже неподготовленному читателю.

Практики:

1. Обеспечьте единообразие и стандартизацию. Разработайте или следуйте руководству по фирменному стилю вашей компании. Создайте шаблоны документов и используйте единую терминологию.

2. Используйте модульность. Разбивайте сложные концепции на удобочитаемые документы.

3. Проектируйте юридические экосистемы. Думайте не только об отдельных документах, но и их связанности и синхронности.

4. Сложность текста должны быть на уровне чтения восьмого класса. Чем проще написан текст, тем вероятнее что он будет понят читателями.

5. Создавайте пояснительные записки для сложных документов. Если обеспечить простоту текста невозможно, необходимо создать справочный материал, который на простом языке раскроет ключевым моменты документа. Справочный материал должен находиться в том же месте, где и документ.

6. Запрещено использовать фотографии текста. Никогда не используйте сканы или скриншоты текста.

7. Избегайте документов больше 7 станиц. Сотрудники вряд-ли будут читать большой текст.

8. Пишите четкие заголовки. Заголовки глав должны однозначно раскрывать их суть.

9. Придерживайтесь осмысленной последовательности. Порядок прочтения текста должен иметь смысл.

10. Отделяйте разделы строкой. Визуально отделяйте один раздел от другого. Это упростит усвоение текста.

11. Используйте один абзац для одной мысли. Для создания четкой структуры и отсутствия “смысловой каши“ не совмещайте несколько мыслей в одном абзаце.

12. Избегайте абзацев более 6 строк. Если ваш абзац занимает более 6 строк, значит он или перегружен или может быть разделен на 2.

13. Избегайте канцеляризмов, там где это возможно. Избегайте ненужного жаргона или, при необходимости, поясняйте термины прямо в тексте.

14. Избегайте аббревиатур. Избегайте сокращений или приводите их расшифровку рядом.

15. Выделяйте самое важное в начало. Наш мозг лучше запоминает то, что расположено в начале текста.

16. Выделяйте ключевую информацию. Используйте жирное выделение, курсив, подчеркивание или цвет.

17. Используйте визуальные материалы, там где это возможно. Используйте диаграммы, значки, шкалы, блок-схемы и т.д. Показывайте, а не просто рассказывайте. Схемы воспринимаются мозгом лучше чем текст.

18. Размер визуального материала должен быть не менее 500Х500 пикселей. Использование меньшего разрешения усложнит его восприятие.

19. Используйте шрифты без засечек. Выбирайте читабельные шрифты, например, такие как Arial, Helvetica, Montserrat.

20. Используйте не менее 14 размера шрифта. Более крупный текст упростит его восприятие.

21. Используйте списки если необходимо перечисление 3 и более элементов. Сплошное перечисление усложняет восприятие текста.

22. Используйте гиперссылки. Если вы ссылаетесь в тексте на иные пункты, добавьте гиперссылку для упрощения навигации. Назначение каждой гиперссылки должно быть ясно из её текста.

23. Создавайте многоязычные документы. Если в вашей компании говорят более чем на 1 языке, переводите созданные документы.

24. Обеспечьте контрастность текста и фона на уровне более 10. Нужно для комфортного восприятия написанного. Для проверки используйте сайт https://imagecolorpicker.com/color-contrast-checker.

25. Обеспечьте отсутствие фонового визуального шума. Не располагайте позади текста визуальные эффекты.

Реалистичность и достижимость

Каждому из нас знакомы политики и регламенты, которые при прочтении вызывают очевидное понимание: их невозможно выполнить или это экономически неоправданно. Это неизбежно ведет к конфликтам, финансовым потерям и управленческим просчётам.

Такой документ с самого начала обречён стать бесполезным и формальным.

Практики:

1. Используйте итеративное прототипирование. Создавайте последовательные версии документа (прототипы), каждая из которых детализируется на основе обратной связи.

2. Обеспечьте сотрудничество с заинтересованными сторонами. Создайте рабочую группу, которая будет проверять реалистичность требований в прототипах. Включите в рабочую группу представителей заинтересованных сторон.

3. Проведите рецензирование финальной версии документа. После того как финальный документ будет разработан, проведите предварительное согласование заинтересованными сторонами.

Обратная связь

Как и всё в этом мире, документ не может быть идеальным. Постоянное совершенствование — неотъемлемая часть работы с документацией, а улучшения без обратной связи бессмысленны.

Сбор отзывов не только повышает эффективность документа, но и улучшает взаимодействие между всеми заинтересованными сторонами.

Практики:

1. Обеспечьте возможность оставлять обратную связь. Обеспечьте единый интерфейс подачи обратной связи (укажите контактное лицо, форму обратной связи или предусмотрите возможность комментирования или сбора отзывов)

2. Инициализируйте сбор обратной связи. Обеспечьте инициативный сбор обратной связи перед разработкой новой версии документа или 1 раз в заданный промежуток времени.

Поговорим о выполняемости

Следующий вопрос, который я задал себе: как понять, что я эффективно управляю документом? Чаще всего самый простой ответ оказывается самым верным — спросить. Вы можете напрямую обратиться к человеку, для которого этот документ предназначен; однако, чтобы обратная связь не была хаотичной, я подготовил перечень вопросов, который вы можете использовать.

Вопросы

Прозрачность и доверие

1. Я знаю где лежит документ

2. Я могу получить беспрепятственный доступ к документу

3. Я уверен/на что мне доступна последняя версия документа

4. Я знаю кто разработал документ

5. Мне не нужно скачивать дополнительное программное обеспечение чтобы открыть документ

6. Цель документа четко сформулирована и понятна

7. Документ имеет введение, объясняющее контекст

8. Содержание соответствует заявленной цели

9. Присутствуют все необходимые ссылки на источники

10. Все требования документа понятны

Адаптация под читателя

1. У документа есть чёткая, логично построенная структура

2. Идеи в разных частях текста не повторяются

3. Документ нельзя сократить без потери смысла

4. Документ не уходит в нерелевантные детали

5. В документе достаточно примеров/иллюстраций для понимания

6. Каждый абзац раскрывает одну мысль

7. В документе отсутствуют отклонения от темы

8. Документ легко читать

9. Документ можно прочитать в течение 20 минут

10. Я не теряю фокус при прочтении документа

11. Документ раскрывает одну тему

Реалистичность и достижимость

1. Я принимал/ла участие в разработке документа

2. Требования документа выполняются/могут быть выполнены

3. Документ проходил мое рецензирование

Обратная связь

1. Я знаю как я могу дать обратную связь по документу

2. Ко мне обращались с просьбой дать обратную связь по документу

3. Я знаю, кому я могу направить обратную связь

4. Документ не требуется дорабатывать

5. Нет информации, которую можно было бы добавить в документ

6. В документе нет ненужных или неинформативных частей

Соответствие

Также, для себя я определил 3 уровня для документов, которые я пишу. Логика определения уровня очень простая и привязана к вопросам выше.

Заключение

В конце хочется сказать — я хочу чтобы документы писались хорошо и поэтому использую ПАРО. Концепция не претендует на ультимативность, и она точно нужна не всем. Вы можете применять ее практики на свое усмотрение, возможно их часть к вам просто не применима.