Документация в геймдеве
10 января 2019 года на Полигоне состоялась встреча представителей некоторых минских игровых студий и одной зарубежной, посвященная документации, используемой в разработке игр.
Список принявших участие компаний:
- Abelana VR Productions
- Gismart
- Payara Games, Ltd.
- Iridescent
- King (ответили письменно)
- Melsoft Games
- Wargaming
Встреча длилась 2 часа.
Ниже вы можете увидеть список основных вопросов и краткое, обобщенное резюме на основании ответов всех участников.
- Для чего необходима документация в современном мире, на ваш взгляд?
Документация нужна и важна для ведения бизнеса — это 100%. Даже в небольших студиях и на краткосрочных проектах (в гипер-казуалках, например).
Что может дать качественная документация? Вот краткий список ответов:
- Сокращение сроков разработки
- Уменьшение различного рода ошибок
- Оптимизацию производственных процессов
- Быстрее «въезжать» в то, что необходимо сделать
- Работу в одном информационном поле
Еще один интересный момент, который был озвучен: при продаже бизнеса (технологические компании, покупатели или инвесторы) смотрят на качество и полноту документации. Если по этому пункту есть пробелы, то сделка может и не состояться.
Иногда люди увольняются и уносят знания с собой и потом не найти никаких следов, зачем что-то вообще делалось. Порой кто-то болеет или работает удаленно — с документацией проще получить апдейт с минимальной задержкой.
Отсутствие документации может загубить проект! Это боль!
2. Знаете ли вы примеры крутой документации, которая вам нравится?
Вспомнили инструкции IKEA, LEGO, американские военные и космические мануалы 🙂
Естественно, это вдохновляющие примеры, которые показывают, что даже сложные и порой занудные вещи можно сделать интересными и понятными.
Есть ли документация в вашей компании и для чего она необходима?
Документация есть во всех компаниях, представители которых пришли на встречу, основное предназначение можно увидеть в ответе на 1-ый вопрос.
Документы можно условно разделить на 2 группы: обязательные для изучения всем и специфические, для определенной группы людей.
При разработке гипер-казуалок техническая документация создается при необходимости.
При этом у всех разные проекты. От ААА-игр, которые разрабатываются по 10 лет, до гипер-казуалок, которые делаются за 2 недели.
Бывает минимальная документация, скорее для себя и своей команды, чтобы не забыть, что мы делаем и для кого.
4. Может ли документация являться частью культуры компании? Если да, то как у вас с этим?
Культура в компании — вопрос требующий времени на обсуждение. Однако, все участники признали, что документы являются частью культуры. Например, в одной из компаний все документы на английском языке. Т.е. если вам это не нравится, то, возможно, вам не по пути.
А еще документация может влиять на сплоченность команды.
5. Как передаются знания новичкам, которые приходят в вашу компанию?
Знания передаются путем изучения документации и в устной форме. Для некоторых вещей документы просто необходимы, чтобы не было «испорченного телефона» при передаче важной информации.
6. Если у вас есть аутсорс разработка, то как получают информацию ваши партнеры?
В компаниях не используют аутсорс разработку, но все согласились с тем, что если бы она была, то без качественных и полных документов — никак!
7. В какой форме должна быть современная документация (тексты, видосы, интерактив и т.д.)
Прямого ответа на вопрос не было, но сейчас в Минских компаниях преимущественно используется текст, а для некоторых ситуаций хорошо подойдут короткие видеовставки или гифки.
Для улучшения качества восприятия в документы интегрируются иллюстрации и схемы для понимания динамических событий — эффектов, анимации и др.
Некоторые считают: чем более интерактивная документация, тем лучше. Тексты скучно читать и высока вероятность что-то пропустить.
8. В какой форме документы у вас в компании?
У всех преимущественно в текстовой и чуть-чуть видео (см. вопрос 7).
9. Устраивает ли вас ситуация с доками в вашей компании? Хотите ли вы изменить или дополнить текущий формат доков в вашей компании? Чего вам не хватает от текущей документации?
Большинство устраивает текущее состояние, но несмотря на это, всем хочется улучшений. Например, структуризацию или контроль актуальности.
Иногда возникают проблемы с поиском необходимой информации.
А кому-то немного не хватает текущей документации и есть желание закрыть пробелы по некоторым направлениям.
10. По каким направлениям есть доки у вас в компании? Арт, программинг, ГДД, ТДД, QA и чек-листы, Pipeline и т.д.?
Большая часть документов это:
- ГДД (есть у всех, но в разных видах и состояниях актуальности)
- доки, связанные с программным кодом
- QA и чек-листы
- документация к редакторам
- какая-то вводная (краткая) информация для новичков
- технические гайдлайны, связанные с разработкой
Документация, связанная с артом или пайплайнами, есть только в одной (крупной) компании. Это скорее связано с особенностями проектов.
Это очень интересная тема и хотелось бы обсудить ее. Если у вас есть такого рода документы — пишите и приходите, соберемся еще один раз отдельно.
11. Кто у вас занимается документами? Отдельный выделенный человек, группа людей или каждый по чуть-чуть вносит свою лепту?
В основном документами занимаются геймдизайнеры и проджект-менеджеры. Только в 2-ух компаниях есть выделенные люди, а в остальных все по чуть-чуть вносят свой вклад.
Доступ на редактирование/комментирование документов есть у всех работников.
12. Сколько времени занимает создание документов?
Конкретных цифр озвучено не было. Одна из проблем, что времени на это не хватает. В приоритете оказывается основная работа, а не написание текстов. Особенно это касается программистов.
13. В какой системе ведуться доки? Wiki, Confluence и т.д.
У большинства это Confluence, а на втором месте Google Docs. Зависит от размера и типа документов. Для небольших компаний Docs вполне хватит.
Задачи (один из видов документации) у многих в Jira.
14. На каком языке ведется документация?
На русском. В одной компании на английском. В самой крупной и на русском, и на английском.
15. Есть ли правила создания доков? Вообще, нужны ли правила?
Конкретные правила есть только в самой крупной компании. Общие правила оформления и шаблоны используют все.
Да, правила, необходимы. Это ускоряет создание и повышает качество документов (читабельность).
16. Как оценивать качество документации?
Если у человек после прочтение ноль вопросов и он все понял — это, наверное, и есть один из главных критериев качества.
Один из возможных способов улучшения документации: давать изучать ее новичкам пришедшим в компанию, получать от них фидбэк и прислушиваться к нему.
На этом, про документацию все. Спасибо, что прочли — надеемся, было полезно!
Если у вас есть интересные темы для обсуждения связанные с разработкой игр — сообщайте нам любым удобным способом. Причем, речь идет не только о графике, но и о любых бизнес-процессах в геймдев. Соберемся и поделимся опытом! Будет интересно!
