Документация : В Tech мы проводим значительное время, производящую пользовательскую документацию, включая документы API, руководства, базы знаний, учебные пособия и руководства по эксплуатации. Мы делаем это, потому что пользовательская документация является частью пользовательского опыта нашего продукта; Без документов люди не могут использовать наш продукт.
То же самое мышление может и должно быть применено к нашим операциям. Внутренняя документация является ключом к созданию наших команд на успех, особенно в командах, которые являются очень сложными (как инженерные организации) и роли или задачи, которые делаются одним человеком. Внутренняя документация может включать в себя стандартные операционные процедуры (пошаговые препараты для процессов), однораговые, короткие, отчеты, внутренние информационные бюллетени, шаблоны, тренировочные видео и многое другое. Эти артефакты документируют проекты команды, процессы, задачи, системы, формирующие краеугольный камень системы управления знаниями команды. (В этом сообщении «Внутренняя документация» относится к документам, предназначенным для собственного использования команды.)
В этом посте вы узнаете, что управление знаниями является и как он претендует на растущие команды, и три типа документов, которые каждая команда должна создать.
Что такое управление знаниями и почему это важно?
Управление знаниями гарантирует, что коллективные знания и информация захватываются и распространяются по всей организации. Он гарантирует «убыток знаний» от нормального оборота, облегчает обучение команде и помогает новым членам команды на борту быстрее. Управление знаниями в виде внутренней документации обеспечивает репливируемые процессы и защиты от единых точек отказа.
Представьте себе присоединение к инженерной организации, составляющей подтексты, состоящие из инженеров и менеджеров по программам на разных уровнях. Вы на одном из подтекстей и просят присоединиться к кучу встреч. Каждая встреча служит другому назначению, но повестка дня не передается заранее, и все на звонок, кажется, знают о том, что они должны отвечать, и что они должны делать дальше. После звонка вы видите билеты в очередь, но вы не понятно, что означают любой из статусов. Что вы делаете дальше?
Вы, вероятно, посмотрите на любую документацию, чтобы помочь вам понять, на что предназначены для заседаний, как назначены рабочие элементы, и что означают разные состояния в рабочих элементах. В отсутствие этого вы можете добраться до коллеги, чтобы спросить их на руководство. Теперь, как бы вы чувствовали, если бы вы всегда должны были спросить коллеги, что делать дальше? Несколько раз в день, каждый день, в течение недель или месяцев?
В командах, которые имеют хорошие практики управления знаниями, мы наблюдаем:
- Лучше бортовое переживание
- Более эффективное управление времени
- Более четкое общение
- Увеличение морального морала
- Более последовательный вывод
Тем не менее, команды с плохими практиками управления знаниями имеют:
- Меньшая ясность и прозрачность
- Работа, которая варьируется в зависимости от качества и согласованности
- Конфликтующие указания о том, что делать в конкретных ситуациях
- Нижний моральный моральный мораль из-за того, чтобы преследовать ответы, вместо того, чтобы получать вещи
Я провел несколько лет документированных систем и процессов, даже когда я был единственным человеком в функции. Я успешно обучил новые коллеги и прошел свою работу плавно другим с минимальным прерыванием в результате инвестирования времени в управлении знаниями. Создание внутренних документов позволяет вашей команде понять, что от них ожидается, и что им нужно сосредоточиться. Это также позволяет вашей команде пройти знания и тренировать других более эффективно.
Какие внутренние документы мы должны создать?
Внутренние документы предназначены для собственного использования команды и должны жить где-то, что команда может легко получить доступ. Если возможно, установите разрешения, чтобы только члены команды могли просматривать эти документы. Все, что предназначено для более широкой аудитории, может жить в компании Wiki или в более «публичном» районе на общем диске компании.
Как минимум, вот три документа, каждая команда должна создавать:
Документ инвентаризации проекта . Инвентаризация, как правило, типичная таблица, перечисляет отдельные проекты и инициативы, за которые отвечают команда и работает над. Инвентарь указывает на сроки, уровень приоритета, владельца проекта, зависимости и поддерживающие процессы. Отдельная «электронная таблица инвентаризации задач» также может быть создана для поверхностных продолжающихся работ, которые поддерживают команды проектов. Этот запас является живым, дыхательным документом и должен регулярно обновляться (ежемесячно или ежеквартально), чтобы отразить изменение приоритетов.
Стандартные рабочие процедуры (SOP) Отказ Создайте SOP для документирования любого процесса, который имеет решающее значение для работы команды. Цель состоит в том, чтобы документировать пошаговый процесс процесса от начала до конца. Я создал SOP вообще, принимая новые запросы, публикующие сообщения в блоге, создании и отправке информационных бюллетеней, обновление базы данных и доставка нового изменения на сайте. Обязательно перечислите любые зависимости и шаги непредвиденных обстоятельств, если что-то неожиданное или нежелательное. И используйте скриншоты!
Команда бортовой документ . Это может быть шаблон, который настроен для каждого нового проката. Док на борту должен включать:
- Введение команды: кто команда, то, что она делает, где она сидит в организации, и какова его цель
- Список членов команды, их названия и адрес электронной почты их компании
- Роль Описание: короткая запись того, что такое роль этого человека и что они сделают
- Ссылки на компанию Wiki, Irnanet или Handbook
- Список высокого уровня 30, 60 и 90-дневных целей
- Кто есть кто: Список команд или частных лиц, которые этот новый человек будет тесно сотрудничать, а кто они должны встретиться со своими первыми несколько недель
- Ритм вашей команды (ROB) Информация: список командных встреч и их описания, списки распространения для присоединения, рабочих часов, каналов связи (электронная почта, провисания и т. Д.), Списки систем и инструментов, которые используют команды и их целы.
Кроме того, каждый документ должен включать метаданные, такие как:
- Название документа («Q1 2020 Инвентаризация проекта»)
- Дата создания
- Прошлой обновленный
- Владельцы документов и участников
Вывод
Внутренняя документация является неотъемлемой частью любой системы управления знаниями компании или команды. Внутренние документы содействуют передачу знаний между членами команды, создают лучший опыт в бортовом опыте и содействовать согласованности и эффективности в рамках организации.
Этот пост был изначально опубликован в моем блоге.
Я Стефани, стратегирование контента и технический PM. Посетите developersguideTocontent.com, чтобы узнать больше о моей работе!
Оригинал: «https://dev.to/radiomorillo/the-what-why-and-how-of-internal-documentation-40po»