Как правильно писать документацию проекта?
В данный момент разрабатываем проект, пишем все с нуля. Разработкой занимаются два программиста.
В проект планируем взять еще 2-3 человек, вот у меня и стал вопрос — как правильно писать документцию, чтобы только-что пришедший человек не дергал сильно программеров, которые работают, а почитал доки и начал работать.
Может быть еще ситуация, что программист, который писал проект завтра уйдет — а информации нет.
Прошу, подскажите, как вы организуете процесс написания доков. Как много времени на это тратится и кто этим занимается.
- Вопрос задан более трёх лет назад
- 8881 просмотр
2 комментария
Оценить 2 комментария
Ну как вариант посмотрите в сторону UML + написание кода в едином стиле
Neoline: ну-ну ) Тогда предлагаю вам скачать исходник постгрес и разбираться в них без чтения документации.
Решения вопроса 3

Робот @iam_not_a_robot
Да просто подсмотрите в рабочем проекте например www.tinymce.com/wiki.php/Configuration
Только с поправкой что для разработчиков пишете а не для юзеров.
Какие блоки, классы за что отвечают вкратце, где костыли которые желательно переписать, объяснить где тут сторонние модули если есть, магию объяснить если имеется в проекте.
Ответ написан более трёх лет назад
Комментировать
Нравится Комментировать

Эдуард Тибет @eduardtibet
Technical Writer / Documentation Engineer
В больших компаниях (или при отлаженных процессах) этим занимается т.н. Технический писатель (Technical Writer). Далее я вам подскажу, как надо делать «по уму» без разных XP-техник и т.п. Прислушиваться к советам или нет — будете решать сами.
В вашем случае, думаю, брать TWR смысла нет, т.к. коллектив маленький/процессы еще не отлажены. Вы, конечно, можете взять TWR для постановки процесса документирования в вашей компании, но специалисты этого уровня — это Lead Technical Writer и его расходы на него будут сравнимы с уровнем разработчика. Сразу же говорю, что никакой студент-техпис вам работу не поставит.
Имейте в виду, что некоторые участники в тех тредах с трудом анализируют информацию 🙂
Можете опубликовать ответы на заданные вопросы здесь, и я постараюсь подсказать вам возможные решения.
Ответ написан более трёх лет назад
Комментировать
Нравится Комментировать
C++/Qt developer/Tech Lead
На мой взгляд для команды из 4-5 программистов не нужен технический писатель. Вы ведь не SDK или еще чего подобное разрабатываете, которое пойдет наружу сотням-тысячам пользователей.
На сколько я понял речь идет о внутренней документации для разработчиков. И в этом случае подойдут простые и проверенные решения как:
— Документирование исходного кода. Инструменты типа Doxygen вам в помощь
— Документирование каких-то особенностей вне кода. Любые варианты wiki вам помогут. Например, MediaWiki
— Документирование архитектурных решений. Можно использовать различные инструменты для UML проектирования, типа StarUML или Umbrello
— Дополнительно можно задокументировать разные API и прочие штуки которые не попали в предыдущие части. Для этого вполне подойдет или wiki или те же google docs.
Ну и конечно же не забудьте использовать систему контроля версий исходного кода и придерживаться принципа атомарности коммитов, тогда это тоже будет не плохим подспорьем.
Ответ написан более трёх лет назад
Комментировать
Нравится Комментировать
Ответы на вопрос 1

Почитал доки и начал работать, это надо документировать процессы. От того где взять задачу, какие правила по её разработке, сдаче, тестировании. Правила владения кодом, комментирования, рефакторинга, работы с ветками, выкатками, кодейстайлом.
Грамотное оформление проектной документации

В соответствии с «Градостроительным кодексом РФ» от 29.12.3004 №190-ФЗ (ГрК РФ) статьей 48: проектная документация – это документы, которые содержат материал в текстовых или графических форматах, определяют различные строительные решения, обеспечивающие строительство, реконструкцию объектов, их частей, а также капитальный ремонт.
Из этой нормативной выдержки понятно, что проектная документация предназначена для оценки соответствий основных технических решений и законодательства, требований заказчиков и документов в сфере стандартизации для оформления соответствующих бумаг.
Способы оформления проектной и рабочей документации
Документальное оформление имеет ряд ключевых требований не только к содержанию, но и к оформлению. Для создания проекта, необходимо следовать нормам и правилам СПДС и ЕСКД. Оформить проектную документацию можно в классическом бумажном виде или в цифровом (электронном). В бумажном виде документы необходимо прошить и пронумеровать. Нумерация проектной документации по ГОСТу осуществляется арабскими цифрами, учитывается титульный лист.
Электронная форма должна быть подана с использованием ЭЦП, заменяющей бумажную подпись и предназначенной для идентификации заявителя. Чтобы получить ЭЦП, нужно обратиться в удостоверяющий центр. Электронная документация должна полностью совпадать с названием бумажного варианта. Проект дополняют файлами с различными расширениями и указывают не более 150 носителей. Входящие в состав проекта текстовые приложения объединяют в дополнительные папки, а таблицы могут оформляться в отдельных файлах. Находящиеся в приложениях документы не требуют подписи.
Цифровое оформление является предпочтительным и для него соблюдаются нормы ГОСТ 2.051-2013. Разработчик проекта должен взять на себя ответственность за обеспечение соответствия между бумажными документами и электронными.

Как оформляется проектная документация: технические требования
Для того чтобы не было недочетов и причин для отрицательного решения при первичной проверке или экспертизе, необходимо с точностью соблюдать все нормы, которые относятся к проектной и рабочей документации. Они затрагивают не только часть по технологии, но и по оформлению.
Общеустановленными правилами указано, что:
- На титульном листе должно содержаться название проекта, наименования заказчика и проектной организации, ФИО проектировщика. Также должна быть прописана информация о лицензиях или договорах, месте и годе оформления, а также необходимо сделать пометки о составлении и согласовании проектных бумаг (поставить штамп или печать).
- Если в проектную документацию внесено две или более частей – на каждой из них нужно оглавление.
- Проектная и рабочая документация: шифры в ней должны соответствовать ГОСТ Р 2.105-2019, учитывая разделы настоящего стандарта 5.1 и 5.2.
- Все таблицы нужно оформлять арабскими цифрами.
- В текстовую часть проекта должны включаться данные о проекте, количестве используемых списков, таблиц и приложений, данные о сметной стоимости строительства.
- Источники добавляются в виде текстового приложения к документам, разделяя их на опубликованные и неопубликованные.
- Правила оформления говорят, что каждое из приложений проекта должно быть составлено как продолжение документа или самостоятельный раздел.
- Графические материалы проектной документации должны иметь номера, масштабирование, наименование проектной компании и ФИО исполнителя проекта. Каждое из обозначений указывается в приложениях или на отдельных листах, в соответствии с условными знаками.

Как не должны оформляться документы: основные признаки некачественного проекта
Некачественная документация определяется наличием ряда недостатков:
- Если в проекте не хватает ряда документов, отсутствуют обязательные разделы или проектные сведения внутри разделов, например, инженерные расчеты, схемы и тд;
- Неполные чертежи, отсутствуют принципиальные схемы, узлы или расчетные обоснования;
- Листы документации без подписей специалистов, ГИПа;
- Разрешение на внесение изменений в проектную документацию не было получено, но они внесены после утверждения проекта. Внесение изменений возможно только до подачи на утверждение;
- Устаревшие или недостоверные инженерные изыскания;
- Часто встречаются неверные расчеты объемов по разным видам работ, что влияет на сметную стоимость строительно-монтажных работ.
Подобные нарушения могут быть выявлены экспертизой, и, если замечания не будут во время ус транены, то застройщик не получит разрешения на строительные работы. Проектно-сметная документация по ГОСТу не должна содержать ложные расчеты и сведения.
Не стоит гнаться за низкой ценой и привлекать непроверенные и неизвестные компании, ведь именно подобные случаи приводят к риску получения некачественных результатов работ и потерям в итоге времени и денег. Лучше обратиться в надежную, профессиональную и проверенную организацию, имеющую значительный опыт по разработке проектной и рабочей документации, прохождения государственной экспертизы. Группа компаний КТБ Железобетон гарантирует высокое качество при разработке проектной и рабочей документации, что обеспечит застройщику высокую надежность и безопасность при строительстве и эксплуатации объекта.
Поделиться:
Новые статьи Популярные статьи
- КТБ Железобетон в проектно-образовательном интенсиве «Школа Шухова 3.0»
- Строительный контроль сегодня и завтра
- Аудит проектной документации
- Исходные материалы для проектирования
- Проектно-изыскательская документация
- Правила обследования зданий и сооружений
- Обследование конструкций зданий и сооружений
- Виды лабораторий в строительстве
- Аккредитованная строительная лаборатория
- Сроки разработки проектной документации
Документация на IT-проектах: как сократить количество ошибок на проекте
Без документации не обойтись на всех этапах разработки и внедрения IT–проектов. От создания концепции до введения системы в эксплуатацию. Она позволяет структурировать работу команды и не откланяться от сформированного плана работ.
На онлайн-тренинге “Документация на IT–проектах” Елизавета Левицкая, (Функциональный архитектор | РП | РПП), рассказывает, какие типы документов рождаются на каждом из этапов жизненного цикла проектов, и что должны содержать эти документы. В статье сделали выжимки из этого тренинга.
Что такое проектная документация и какие она выполняет функции
Любая разработка начинается с идеи. Чтобы что-то создать, сначала это нужно представить в виде текста или графически. Процесс описания идеи от момента ее возникновения до выпуска релиза возможен с помощью проектной документации.
Проектная документация представляет собой набор документов, которые описывают все аспекты проекта: его цели, задачи, планы и требования. Эти документы нужны для того, чтобы проект был выполнен качественно и в срок.
Документация на IT–проектах выполняет ряд важных функций:
– помогает определить цель и задачи проекта, а также способы их достижения. Она дает ясное представление о том, что должно быть достигнуто в результате работы над проектом;
– является эффективным средством коммуникации между участниками проекта: разработчиками, тестировщиками, заказчиком и другими заинтересованными сторонами, т.к. наглядно показывает все аспекты проекта;
– определяет последовательность выполнения работ, сроки и ответственных лиц за каждый этап. Это позволяет лучше организовать работу команды и обеспечить ее эффективное выполнение;
– позволяет оперативно проводить расчеты затрат и управлять ими в ходе выполнения проекта, т.к. содержит информацию о ресурсах, необходимых для реализации проекта — людях, материалах, бюджете и технических средствах;
– является гарантией прозрачности и контроля за выполнением работ;
– позволяет проводить аудит и анализ результатов работы.
От каких целей зависит формирование документации
Формирование проектной документации нужно, прежде всего, для снижения рисков Заказчика и Исполнителя.
Цели формирования проектной документации:
– избежать споров с заказчиком, связанных с неоднозначным пониманием;
– сократить риск «забытых требований»;
– снизить риски возникновения гарантийных обязательств;
– ввести в курс дела новых сотрудников;
– ускорить и упростить принятие управленческих решений по ведению проекта;
– в любой момент иметь возможность комплексно оценить ход проекта: что из процессов эффективно, что нужно улучшить или совсем убрать.
Основные виды документации на IT–проектах
Основные виды документации на IT–проектах играют важную роль в успешной реализации проекта. В каждой компании имеются свои шаблоны этих документов. И они часто далеки от совершенства. Что подчас приводит к недопониманию и даже конфликтам между заказчиком и подрядчиком.
Если вы хотите избежать споров с заказчиком, связанных с неоднозначным пониманием, сократить риски «забытых требований» и риски возникновения гарантийных обязательств, в ваших интересах сформировать по проекту наиболее полный пакет документов.
В этот пакет документов обязательно должны входить:
Техническое задание (ТЗ). ТЗ содержит описание требований к проекту, его функциональности, архитектуры и прочих технических аспектов. Оно служит основой для всего последующего процесса разработки.
План проекта. Он определяет цели, задачи, сроки и ресурсы, необходимые для успешной реализации проекта. План проекта помогает управлять работой команды, распределять задачи и контролировать выполнение работ.
Документация по программному обеспечению. Это может быть спецификация функциональности системы или подробное описание алгоритмов работы программного продукта. Данная документация помогает разработчикам лучше понять требования к системе и реализовать их на практике.
Документация по тестированию. Это может быть план тестирования, описание сценариев тестирования, результаты проведенных тестов и прочее. Документация по тестированию помогает обнаружить и исправить ошибки в программном продукте до его выпуска.
У каждого проектного документа должна быть структура: заголовок, название проекта, автор, история изменений, кто подписал документ и краткое введение, в котором описывается цель создания каждого документа.
Научиться грамотно оформлять проектные документы можно на онлайн-тренинге «Документация на IT–проектах» CORS Academy.
Тренинг создан на основе прошедшего вебинара-практикума, в котором приняли участие более 100 человек.
Чем будет полезен онлайн-тренинг «Документация на IT–проектах»
За 4 часа онлайн-тренинга вы пройдетесь по всем этапам проекта и рассмотрите, какие типы документов рождаются на каждом из этапов жизненного цикла проектов, от устава до плана подготовки системы к опытно-промышленной эксплуатации; что должны содержать эти документы, и как эффективно их использовать в проектах.
Со спикером онлайн-тренинга Левицкой Елизаветой вы подробно разберете:
– как правильно использовать документы на каждом из этапов проекта и какие взаимосвязи влияют на содержание документа;
– как обезопасить себя от дополнительных требований Заказчика и внеплановых доработок за счет документирования;
– как отчеты по проекту могут помочь избежать недопониманий и расхождений в ожиданиях с Заказчиком;
– как ничего не упустить при подготовке к запуску проекта в опытную эксплуатацию.
На тренинге, приобретя тариф «Профессиональный», бонусом вы получите шаблоны, которые используют эксперты в своей работе.
У спикера вебинара большой опыт эффективного руководства проектами внедрения ПО на крупных предприятиях с 2013 г. На примерах из собственной практики Елизавета расскажет, как грамотное оформление документации не раз помогло избежать конфликта с заказчиками и успешно реализовать проект.
Рекомендации по эффективному использованию документации на IT–проектах
Документация является важной составляющей любого IT–проекта. Она помогает командам разработчиков и менеджерам понять, как работает проект, какие функции он выполняет и каким образом они должны быть реализованы. Однако, часто документация становится излишне громоздкой и нечитаемой, что затрудняет ее использование.
Для эффективного использования документации на IT–проектах следует придерживаться нескольких рекомендаций:
1. Структурируйте документацию. Разделите документацию на логические блоки и подразделы. Это облегчит навигацию по ней. Для создания четкой структуры документации используйте заголовки, списки и другие элементы форматирования, чтобы документ можно было легко просмотреть и быстро найти необходимое.
2. Пишите просто и понятно. В каких бы программах вы ни оформляли документацию по проекту, объясняйте все простым языком, без сокращений и запутанных фраз.
3. Поддерживайте актуальность. Обновляйте документацию по мере изменения проекта. Устаревшая информация приведет к ошибкам и неправильным решениям. Чтобы отслеживать изменения, указывайте версии документации.
4. Используйте диаграммы и схемы. Это может значительно упростить понимание проекта Заказчику и команде. Визуальная информация всегда воспринимается легче и лучше запоминается.
Подведем итоги
- Документация – набор документов, которые описывают все аспекты проекта: его цели, задачи, планы и требования.
- Она помогает представить и оценить весь объем работы по проекту.
- Документация нужна, прежде всего, для снижения рисков Заказчика и Исполнителя.
- Чтобы документация была эффективной, ее надо оформлять просто и понятно, вовремя актуализировать и в целом развивать культуру документирования в своей команде.
- Получить готовые шаблоны документов и научиться эффективно вести документацию проекта можно на онлайн-тренинге «Документация на IT–проектах» CORS Academy.
Канал руководителей IT компаний и подразделений, CIO, СDO, CDTO https://t.me/cio_channel
CIO. Сообщество IT руководителей https://vk.com/cio_club
информационно-развлекательные каналы GoodIT:
Как создать идеальную внутреннюю документацию
Допустим, один из ваших коллег работает в команде уже много лет, самостоятельно выполняет кучу заданий, и когда нужно быстро получить ответ на вопрос, все идут к нему.
А теперь представьте, что он решил уволиться.
Двух недель едва ли хватит, чтобы кто-нибудь другой научился работать со всеми задачами этого опытного специалиста в его же темпе. Когда такие люди уходят, команда теряет массу знаний и опыта, на которые все привыкли полагаться.
Простите, если заставили вас нервничать! Но напряжение, которое вы ощутили, является отличной иллюстрацией того, насколько важна внутренняя документация.
Давайте подробно рассмотрим, что вам нужно знать для того, чтобы запустить и (или) оптимизировать этот процесс, не дожидаясь острой необходимости. Вы ведь знаете: готовить сани нужно летом…
Что такое внутренняя документация?
Внутренняя документация — это практика создания и поддержания в актуальном виде подробного описания процессов и процедур, с которым может сверяться любой внутренний участник команды.
Она отличается от внешней документации, которую (как это ясно по названию) используют люди за пределами вашей организации, — например, от инструкций для покупателей.
Вопрос ведения внутренней документации может показаться запутанным, ведь чаще всего его обсуждают в контексте разработки программного обеспечения и ИТ. Таким командам необходимо очень точно документировать код разрабатываемых приложений и ПО.
Несмотря на определенные технические корни, ведение документации может оказаться полезной практикой для всей компании, от отдела кадров до команд по поддержке клиентов.
Типы внутренней документации
В этой статье мы будем обсуждать прежде всего вопросы документирования процессов: записи шагов для выполнения заданий или повторяющихся операций, которыми занимаются участники вашей команды.
Разумеется, это не единственный возможный вид внутренней документации. Другие распространенные типы перечислены ниже.
- Документация команды. Информация, связанная с работой, которую выполняет команда. Это могут быть цели, планы проектов, график работы команды, отчеты о состоянии, протоколы собраний и т. д.
- Справочная документация. Задокументированные процессы относятся к этой более широкой категории. Справочная документация помогает сотрудникам получить знания по важным темам, процессам и корпоративным политикам (к примеру, как подать заявление на отгул).
- Проектная документация. Документация такого типа относится к конкретному проекту. Она может включать в себя предложения, требования к продукту, рекомендации по дизайну, наброски, дорожные карты и прочее.
В этой статье мы поговорим прежде всего о справочной документации (в частности, документации процессов). Но для общего представления полезно знать и о других типах внутренней документации.
Внутренняя документация — это практика создания и поддержания в актуальном виде подробного описания процессов и процедур, с которым может сверяться любой внутренний участник команды.
Для чего нужна документация
Слишком многие компании недооценивают роль внутренней документации (пока нормальное течение процессов не нарушит какой-нибудь кризис, оставив их у разбитого корыта). Согласно исследованию BPTrends, лишь 4 % компаний всегда документируют внутренние процессы. Еще 50 % признают, что занимаются этим вопросом от случая к случаю.
А теперь пара реплик с импровизированной трибуны: не будьте частью такой статистики! Внутренняя документация действительно важна, и по многим причинам.
Выполняйте больше работы, не тратя время впустую
Допустим, вам требуется вместо коллеги выполнить рассылку клиентам информационного обзора за месяц. Быстро ли получится, если вы станете разбираться во всем самостоятельно? Или же будет гораздо быстрее, если перед вами окажется подробная инструкция со снимками экрана, поясняющими, как именно нужно извлечь и распространить информацию?
Второй вариант очевидно быстрее, да?
Внутренняя документация становится ресурсом для типовых процессов. Когда требуется заполнить отчет о расходах или спланировать встречу с клиентом, любой участник команды может обратиться к соответствующей документации, чтобы эффективно выполнить свои задания. Это гораздо лучше (и представьте, насколько спокойнее), чем выполнять операции самостоятельно методом проб и ошибок.
Поднимите адаптацию сотрудников на новый уровень
По данным компании Gallup, лишь 12 % сотрудников полностью согласны, что их организация успешно справляется с адаптацией новых кадров.
И это печально, потому что приступать к новым обязанностям и всему учиться самостоятельно — едва ли не худшее, что может случиться с вами на работе.
Стабильная практика создания внутренней документации формирует для новых участников команды ценный источник знаний, к которому они могут обращаться, спокойно осваивая все тонкости новой работы.
Конечно же, документация не заменит личное общение и работу с наставником в нежный период адаптации. Но она станет ценным дополнением к этому и отличным способом дать новым участникам команды возможность самостоятельно выполнять некоторые задачи с первого же дня.
Запустите процесс обмена знаниями
Слишком часто ценная информация и опыт хранятся только в голове у отдельных участников команды, а значит, недоступны другим. В этом случае увольнение сотрудников становится серьезной проблемой — особенно с учетом результатов одного из исследований, где 42 % опрошенных признали, что выполнение их работы требует уникальных знаний.
Именно поэтому требуется создать единое пространство, в котором будет задокументировано все то, что хранится в голове сотрудников. Это помогает устранить разобщенность, способствует обмену знаниями и очень помогает успешной работе команды в ситуациях, когда обстановка внезапно меняется или кто-то отсутствует.
Рекомендации по управлению документацией
Теперь у вас есть ответ на вопрос «почему» — давайте перейдем к «как».
Следуйте нашим рекомендациям по созданию внутренней документации, и тогда она будет действительно помогать команде, а не раздражать еще сильнее.
Пишите просто и понятно
Если в вашей документации без словаря не разберешься, читать ее никто не станет. Объясняйте все простым языком, не используйте слишком много жаргона, избегайте сокращений и запутанных фраз. Не забывайте выделять подзаголовки и маркированные списки в достаточном количестве, чтобы документ было легко просматривать и находить нужное, не перегружаясь информацией.

Используйте примеры и графические материалы
Не полагайтесь только на текст! Обязательно добавляйте примеры и изображения: они хорошо способствуют пониманию материала. Например, не стоит описывать, как объединить несколько списков электронных адресов в один, чтобы разослать приглашения на ежегодный обед. Лучше покажите этот процесс поэтапно с помощью снимков экрана, сделанных в прошлый раз.
Обеспечьте удобный доступ
Если вы хотите, чтобы документацию использовали, ее должно быть просто найти. Внутренняя документация должна быть всегда под рукой, а не в десятках запутанных подкаталогов. И здесь раскрывается одно из преимуществ Confluence. В Confluence используется открытая структура дерева страниц, а значит, документы не будут теряться под бесконечными слоями каталогов. Называя файлы, подходите с позиции своих коллег, которые будут пытаться найти ваши инструкции. Простые и недвусмысленные формулировки значительно сокращают время на поиски нужной информации.
Добавляйте нужные подробности
Если процесс вам хорошо знаком, есть риск пропустить описание каких-то шагов или упустить из виду важные тонкости. Когда возникают сомнения, лучше писать подробнее. А потом проверьте себя, попросив кого-то, не знакомого с процессом, прочесть документ и сказать, сможет ли он выполнить работу по такой инструкции. Если возникнет заминка, уточните, где именно, и подумайте, как можно пояснить обозначенные места.
Стабильная практика создания внутренней документации формирует ценный источник знаний для новых участников команды.
Дайте дорогу тем, кто готов помочь
Если прочитанное выше еще не подсказало вам эту мысль, поясняем: необязательно вести внутреннюю документацию самому. Привлекайте участников команды к переносу на страницу плодов работы корпоративного разума: пусть они зафиксируют процедуры, которые им хорошо знакомы. В конечном счете, именно они лучше других знают, как решать те или иные задания.
Используйте «живые» документы
В компании и в вашей команде постоянно происходят перемены. И если вы что-то записали, это не значит, что документ больше не будет меняться. Когда один из процессов изменится (к примеру, упростятся некоторые шаги или появится новое ПО), меньше всего вам захочется переформатировать файл PDF или иной статический ресурс. Используйте «живую» документацию (отличным вариантом, кстати, является Confluence), и тогда все ваши внутренние документы будут без лишних усилий развиваться вместе с командой. Кроме того, при таком подходе гораздо проще привлекать к созданию документации других участников команды.
Формирование процесса работы с внутренней документацией
Продуманный процесс формирования внутренней документации (с шаблонами!) может помочь не только всерьез упростить написание документов, но и добиться в этом вопросе единого подхода в масштабе всей компании. Существует процесс для описания процессов — и мы готовы помочь вам его освоить. Выполните следующие шаги.
1. Определите основные процессы
Мы обожаем документацию, но это не значит, что тщательно фиксировать нужно абсолютно все. Конструировать специальные процедуры для единичных или спонтанных событий не требуется.
Начните с создания базовых правил о том, какой тип работы вы будете документировать. Может быть, процесс должен повториться определенное количество раз (допустим, трижды), прежде чем вы примете решение о его документировании? Может быть, этот процесс должен повторяться на регулярной основе (как минимум раз в месяц)?
Ставя перед собой задачу задокументировать абсолютно все, вы явно завышаете планку и рискуете захлебнуться в работе. Поэтому лучше сразу определить критерии, что именно стоит документировать.
2. Создайте стандартный шаблон
Чтобы сэкономить время и обеспечить единую структуру документации, создайте шаблон для общего использования. В этом шаблоне обязательно должны быть следующие поля.
- Краткое описание, для чего существует данный процесс
- Основные участники процесса
- Что требуется для выполнения процесса (ПО, ресурсы и т. п.)
Эти поля послужат гарантией того, что у каждого читателя будет достаточно информации, чтобы легко выполнить описанное в документе.
БОНУСНЫЙ СОВЕТ.
Чтобы подтолкнуть сотрудников к использованию созданного шаблона для документирования своих процессов, подумайте над системой поощрений за такое участие. Возможно, участники вашей команды не считают написание документации приятным процессом, но повысить мотивацию поможет награда за 15 описанных в течение месяца процессов в виде бесплатной пиццы или сокращенного рабочего дня в пятницу.
3. Определите, где хранить описания процессов
И помните: чтобы документацию использовали, к ней нужно обеспечить удобный доступ. Если у вас еще нет специального каталога или портала, где хранятся все подобные записи, обязательно заведите его.
В идеале система, которую вы будете использовать, должна обеспечивать удобный поиск, чтобы другим не приходилось долго копаться, разыскивая нужное.
4. Выделите время для наведения порядка
Даже когда вы внедрите строгий процесс формирования документации, ситуация иногда будет выходить из-под контроля. Документы окажутся в неправильном месте или же потребуется что-то обновить.
Выделите регулярное время (ежемесячно или раз в квартал), чтобы проверять всю документацию и наводить в ней порядок. Это будет касаться как уточнения процессов, так и систематизации хранения файлов. В этом случае ваша система всегда будет в полной готовности, а значит, обращаться к ней будут активнее.
Прочтите это руководство, чтобы подробно разобраться, как организовать процесс ведения внутренней документации.
Чем может помочь ПО для создания внутренней документации
Когда доходит до создания общей внутренней документации, помощь вашей команды становится неоценимой, однако технологии тоже могут серьезно упростить работу. Рекомендуем не использовать файловые системы на отдельных компьютерах, а выбрать специальное ПО для ведения внутренней документации. Такой подход обеспечивает удобство совместной работы: специальное ПО позволяет вместе редактировать страницы, собирать отзывы в комментариях (встроенных или относящихся ко всей странице) и упоминать участников команды, которые внесли свой вклад в процесс.
К тому же программное обеспечение позволяет создать упорядоченный портал, где страницы будут сгруппированы по темам в отведенных местах и где возможен расширенный поиск. Вы получите структурированный ресурс, на который может положиться вся команда.
Похоже, что это хорошая штука? Мы тоже так думаем. Ознакомьтесь с Confluence и начните создавать внутреннюю документацию по единым схемам и без лишнего стресса.
Избавьте команду от лишних проблем и забот
Многие считают, что внутренняя документация — это излишняя формальность. Но представьте еще раз: что случится, если завтра решит уволиться ваш ключевой сотрудник? Сколько ценных знаний и важного опыта вы потеряете?
Если внедрить строгую практику создания документации, вы и ваша команда будете выходить из подобных непредвиденных обстоятельств с оптимизмом и уверенностью.