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