Инженерам необходим определенный набор инструментов и процессов для выполнения своей работы. Пользовательская вики, созданная в Notion, позволяет вам централизовать всю самую важную информацию вашей команды инженеров.
При наличии правильного инструмента организовать всю важную информацию вашей команды в одном месте довольно просто.
Но с вашей нынешней позиции это, вероятно, кажется сложной задачей. Информация может быть разрозненной. Она может быть устаревшей. Это может быть похоже на переполненный чемодан, из которого нужно вытащить все, чтобы найти нужную пару носков.
Поверьте нам. Инвестирование времени в создание единой, центральной инженерной вики принесет долгосрочные дивиденды. Потому что плохая организационная система может привести к неэффективной работе – трате времени на поиски нужной вещи, устаревшей информации, дублирующим проектам, неправильным процессам.
Здесь мы расскажем вам о создании собственной инженерной вики с помощью Notion (вы также можете назвать ее базой знаний) и о том, как она может открыть лучший рабочий процесс для вашей команды.
В этом материале вы узнаете
В этом материале вы узнаете
- Как создать вики для вашей команды инженеров, шаг за шагом
- Как настроить ее в соответствии с потребностями вашей команды
- Как использовать функции и интеграции, полезные именно для инженеров.
Вот лишь один пример того, как может выглядеть ваш готовый продукт:
Почему вики имеет решающее значение для инженерных команд
Спросите себя: где хранится вся информация вашей команды? Если ответ включает несколько пунктов назначения, то, скорее всего, у вашей команды нет центрального источника правды для документов, которые необходимы для эффективной работы.
Вы заслуживаете одного надежного ресурса для:
- Рекомендации по стилю кода, ротация сортировки и информация об инфраструктуре – все это актуально и легко доступно для всех членов вашей команды.
- Ресурсы для новых инженеров, помогающие им быстро освоиться и начать работать.
- Страницы, посвященные различным проектам, над которыми работает ваша команда инженеров, чтобы все были в курсе того, кто над чем работает.
Отсутствие вики означает отсутствие узла для этой информации, что может иметь негативные последствия. Информация становится изолированной, поэтому никто не имеет полной картины происходящего. Назначается больше встреч и бесед, потому что информацию невозможно найти. Работа становится неточной и непоследовательной, потому что инженер использовал устаревшее руководство по стилю.
Организованная и доступная вики помогает решить эти проблемы. Больше не нужно рыться в кладбищах документов, называющих одно и то же (которые, скорее всего, уже устарели).
Все члены вашей команды знают, где найти то, что им нужно, поэтому ваша команда может сосредоточиться на главном.
Настройка вашей инженерной вики
Давайте начнем с нескольких основ и будем работать дальше.
1. Создайте страницу
Это отправная точка практически для всего, что вы делаете в Notion. Страница может содержать что угодно – текст, списки, видео, изображения, базы данных и многое другое. Ваша вики – это страница, на которую вы будете добавлять другие страницы.
Чтобы создать страницу, просто нажмите на знак + рядом с WORKSPACE на боковой панели. Если вы уже находитесь на странице, просто нажмите / и введите page, затем нажмите enter. Каждый раз, когда вы нажимаете /, вы увидите полное меню опций содержимого – мы называем это “косой чертой”.
В нижней левой части вашей боковой панели находится кнопка
Templates.Здесь мы предлагаем вам коллекцию готовых шаблонов, которые вы можете изменить под свои нужды. Они являются отличной отправной точкой, особенно при создании вики.
Находясь в окне выбора шаблонов, нажмите на треугольник рядом с
Engineering, чтобы увидеть варианты. Затем вы можете выбрать Use this template, нажав кнопку Использовать этот шаблон, и тогда он появится прямо на вашей боковой панели в разделе PRIVATE. Когда страница будет готова для совместного использования с вашей командой, перетащите ее в раздел WORKSPACE боковой панели. 2. Создайте подстраницу
Суть создания вики заключается в том, что вы можете иметь множество страниц внутри одной страницы.
Например, на главной странице “Проектирование” вы можете иметь отдельные страницы для репозитория кода, заметок о собраниях команды, руководства по тестированию и т.д. Каждая из этих страниц становится ресурсом вашей команды. Каждая из этих страниц становится ресурсом для вашей команды и может жить бок о бок.
- Чтобы создать такую страницу, введите
/pageи нажмитеenter. Появится новая страница, где вы можете дать ей название и добавить любое содержимое. Чтобы вернуться в вики, используйте кнопку “Назад”. - Чтобы создать сразу много страниц, перечислите все названия страниц, которые вы хотите создать, в виде текста. Теперь выделите их все, нажмите на значок
⋮⋮, который появляется при наведении, нажмитеTurn Intoв и выберитеPage.
Таким образом, все части вашей инженерной организации находятся в одном месте. Вашей команде не придется искать что-то, когда им что-то понадобится – они будут знать, что начинать нужно с вашей вики.
Теперь у вас есть основы вики. Пора ее организовать.
После создания новой страницы добавьте эмодзи и обложку, чтобы придать ей индивидуальность.
Над заголовком вы увидите кнопки
Add icon и Add cover. Для значка можно выбрать один из предложенных эмодзи или загрузить собственное изображение. То же самое касается обложки – выберите из нашего хранилища изображений или загрузите свое собственное.Мы предлагаем вам выбрать идеальный эмодзи для вашей страницы.
3. Структура страницы
Давайте организуем вашу вики для максимального удобства использования.
Вы можете начать с заголовков. Используя /, выберите один из заголовков H1 (самый большой), H2 или H3 (самый маленький). Теперь вы можете использовать функцию перетаскивания для организации страниц в рабочей области.
- Во-первых, используйте перетаскивание для создания столбцов. Возьмите значок
⋮⋮рядом с заголовком и перетащите его вправо, чтобы создать еще одну колонку. Синие направляющие помогут вам. - Чтобы добавить разделительные линии под заголовками для придания им законченного вида, просто введите три дефиса подряд.
- Теперь, снова используя
⋮⋮, возьмите любые страницы и перетащите их в нужные разделы.
Такая категория, как “Инфраструктура”, может включать страницы “AWS” и “Redis”. Все инженерные команды разные, и Notion позволяет вам настроить свою вики в соответствии с потребностями вашей команды.
Все доступно в один-два клика. Так что забудьте о поисках документов. Сэкономьте драгоценное время вашей команды, создав четко структурированную вики, в которой есть указатели на всю необходимую информацию. Notion станет отправной точкой для работы вашей команды.
4. Многие типы контента для инженерных документов
Инструменты, необходимые инженеру для выполнения своей работы, отличаются от инструментов других команд. Notion удовлетворяет эти потребности, поэтому ваша команда может перестать впихивать информацию в негибкое программное обеспечение.
На страницах вы можете встраивать различные типы контента для отображения информации. Нажмите /, чтобы увидеть некоторые из них (среди многих других):
- Блоки кода на любом языке
- gist из Github
- Диаграммы
- Файлы Figma
- Математические уравнения в LaTeX
Вы можете либо выбрать эти опции из всплывающего меню, либо набрать их название, чтобы они появились быстрее, и нажать Enter, чтобы добавить их. Например, /github и /math.
Мы обнаружили, что блоки кода особенно полезны для инженерных команд для обмена информацией, жизненно важной для процесса и последовательности. Чтобы добавить его, введите /code и нажмите клавишу Enter.
Нажмите на выпадающий список в правом нижнем углу появившегося окна, чтобы выбрать язык, который вы хотите использовать. Введите или вставьте любой код, которым вы хотите поделиться с командой, будь то команда для развертывания или часто используемые команды.
Гибкость Notion позволяет хранить множество видов информации в одном месте – так, для проекта, над которым вы работаете, на одной странице может быть все необходимое, чтобы довести его от идеи до запуска. Больше не нужно переключаться между инструментами и вкладками. Прекратите переключение контекста и успевайте делать больше.
Посмотрите наше 3-минутное видео, которое научит вас всему, что нужно знать о блоках кода
Понял? Хорошо. Теперь сделай еще один шаг вперед.
Вы можете вложить в свою вики бесконечное количество страниц. И как только она будет создана, вы сможете получить доступ ко всем ее страницам прямо с боковой панели.
Допустим, в вашей инженерной вики есть страница “Команды”. На странице “Команды” находятся отдельные страницы для подкоманд, входящих в состав вашего инженерного подразделения: iOS, Android, Web, Mac, Windows и т. д.
Такая структура обеспечивает каждому документу свое место, поэтому у вас не будет кучи некатегоризированных загадочных документов, которые плавают без дома. Это также облегчает командам доступ ко всем документам, вложенным в эти страницы.
Это можно сделать прямо с боковой панели, сделав всего пару щелчков мышью.
Посмотреть в действии
Вы учитесь визуально? Мы создали 7-минутный видеоролик, показывающий, как создать базовую вики.
Следующие шаги
Хорошо построенная вики может служить центром для всех спиц вашей инженерной команды.
Она объединяет всех. Она продвигает проекты вперед. Она открывает лучшие рабочие процессы. А с помощью Notion вы можете настроить ее в соответствии с тем, как работает ваша команда.
Создание инженерной вики – это инвестиция в вашу команду и ее работу. Мы надеемся, что это поможет вам на этом пути.