Поэт и гейм-дизайнер лишь

именем различны
Краткий курс по написанию проектной документации

(c) 2010 Playnatic Entertinament 1

 О докладчике

• Макс Янков
• Ведущий гейм-дизайнер, Playnatic
Entertainment
• Более 3 лет в игровой индустрии
• Более 10 коммерческих проектов

(c) 2010 Playnatic Entertinament 2

 Для кого этот доклад

• Гейм-дизайнеры начального и среднего

уровня
• Все, чья работа связана с написанием
документации

(c) 2010 Playnatic Entertinament 3

 О чём этот доклад

• Как писать документацию

• Как донести свои мысли (и не потерять по
дороге)
• Как потратить на это минимум усилий

(c) 2010 Playnatic Entertinament 4

Прежде, чем начать

(c) 2010 Playnatic Entertinament 5

 Прежде, чем начать

• Почему документ необходимо написать?

– Если можешь не писать – не пиши.
– Какие мысли должны быть переданы?
– Где может возникнуть недопонимание?
– Какие договорённости надо зафикисровать?

(c) 2010 Playnatic Entertinament 6

 Прежде, чем начать

• Для кого вы пишете документ?

– Кто эти люди?
– Почему им необходимо прочитать этот
документ?
– На какие вопросы они будет искать ответы?
– Как вы можете облегчить их работу?

(c) 2010 Playnatic Entertinament 7

 Прежде, чем начать

• Насколько актуален будет этот документ в

будущем?
– Уровень «концепта»
• Общие «аксиомы»
• Кратко
• Желательно не менять в будущем

(c) 2010 Playnatic Entertinament 8

 Прежде, чем начать

• Насколько актуален будет этот документ в

будущем?
– Уровень технического задания
• Более развёрнуто
• Быстро «протухает» – буквально две недели

(c) 2010 Playnatic Entertinament 9

Стиль текста

(c) 2010 Playnatic Entertinament 10

 Стиль текста

• Короткие предложения
• Простые, знакомые слова
• Пишите так, как говорите
• Знакомые читателю выражения, комфортный
для него стиль
• Вы пишете документацию, а не
художественный текст!

(c) 2010 Playnatic Entertinament 11

 Стиль текста

• Будьте проще!
– «Сделай настолько просто, насколько это
возможно, но не проще.» А. Энштейн
– Plain language movement (движение за
простой язык): инициатива правительства
США для упрощения языка чиновников:
http://www.plainlanguage.gov/

(c) 2010 Playnatic Entertinament 12

Структура документа

(c) 2010 Playnatic Entertinament 13

 Структура документа

Принцип пирамиды Минто – группирование

идей в поддержку общего тезиса.

(c) 2010 Playnatic Entertinament 14

 Структура документа

Письмо деду морозу

Дорогой Дедушка Мороз!

Помнишь, в прошлом году я писал тебе письмо, чтобы ты мне подарил

железную дорогу, а ты оставил мне под ёлкой один маленький паровоз?
А помнишь, как два года назад я просил тебя ничего не дарить Ване, потому
что он плохо себя ведёт, а ты привёз ему горный велосипед?
А в этот раз я просто попросил тебя подарить мне меч джедая из звёздных
войн,? А ты перепутал и купил мне меч красного цвета!
В-общем, теперь я в тебя не верю и не буду у тебя больше просить подарки.

(c) 2010 Playnatic Entertinament 15

 Структура документа

Письмо деду морозу

Дорогой Дед мороз,

Я в тебя не верю. Вот почему:
1. Ты не подарил мне железную дорогу.
2. Ты подарил Ване горный велосипед.
3. Ты перепутал меч Джедаев и Ситхов.

(c) 2010 Playnatic Entertinament 16

 Структура документа

Письмо деду морозу

Основной тезис

Дорогой Дед мороз,

Я в тебя не верю. Вот почему:
1. Ты не подарил мне железную дорогу. Аргументы,
2. Ты подарил Ване горный велосипед. поддерживающие
3. Ты перепутал меч Джедаев и Ситхов. основной тезис

(c) 2010 Playnatic Entertinament 17

 Структура документа

Письмо деду морозу

Почему Макс
написал письмо?

Макс в меня
Потому что…
больше не верит.

Почему?

Я не подарил
Я подарил Ване Я перепутал
Потому что… железную
велосипед меч джедая
дорогу

(c) 2010 Playnatic Entertinament 18

 Структура документа

Независимые аргументы – индуктивная логика

Наша игра должна
быть походовой

Меньше Можно сделать

Проще для
требования к более сложные
игроков
сетевой части системы

Независимые аргументы

(c) 2010 Playnatic Entertinament 19

 Структура документа

Связанные аргументы – дедуктивная логика

Наша игра должна
быть походовой

Наша аудитория Походовые игры

Шахматы и карты –
привыкла играть в более привычны
походовые игры
шахматы и карты нашей аудитории

Цепь размышления

(c) 2010 Playnatic Entertinament 20

 Структура документа

• Основной тезис
• Вопросы
– Почему?
– Как это сделать?
– Когда?
–…
• Пирамидальная структура

(c) 2010 Playnatic Entertinament 21

 Структура документа

Сверху вниз
• Мы должны сделать игровую систему
– Она необходима потому что…
– Она будет работать следующим образом…
– Она будет выглядеть так…

(c) 2010 Playnatic Entertinament 22

 Структура документа

Снизу вверх
– У нас должен быть разветвлённый сюжет
– Нам необходимо дать игроку чёткие цели
– Во многих аналогичных играх есть квестовые
системы
• Нам нужно сделать квестовую систему

(c) 2010 Playnatic Entertinament 23

Use-case диаграммы

(c) 2010 Playnatic Entertinament 24

 Use-case диаграммы

• Unified Modeling Language – стандартный язык

моделирования, принятый в enterprise-
разработке
• Use-case (сценарий использования,
прецедент) – описание поведения системы в
ответ на запрос

(c) 2010 Playnatic Entertinament 25

 Use-case диаграммы

Что это такое:

Выиграть игру

Игрок

(c) 2010 Playnatic Entertinament 26

 Use-case диаграммы

Убить пирата
Выиграть игру

«include»

Убить врага

Убить ниндзю

(c) 2010 Playnatic Entertinament 27

 Use-case диаграммы

Кажется слишком простым, чтобы быть

полезным, верно?

(c) 2010 Playnatic Entertinament 28

 Use-case диаграмма

(c) 2010 Playnatic Entertinament 29

 Use-case диаграмма

• Где стоит применять:

– Процесс проектирования интерфейсов и
других взаимодействующих с пользователем
систем; игра – это интерфейс
– Документирование систем со сложным
поведением и большим количеством
внешних вызовов

(c) 2010 Playnatic Entertinament 30

Model-Viewer-Controller

(c) 2010 Playnatic Entertinament 31

 Model-Viewer-Controller

• Паттерн (шаблон, приём) программирования,

разделяющий:
– Логику работы приложения (Controller)
– Модель данных (Model)
– Пользовательский интерфейс (Viewer)

(c) 2010 Playnatic Entertinament 32

 Model-Viewer-Controller

Как это работает

Модель
данных
Обновляет Манипулирует

Интерфейс Логика

Видит Использует
Пользователь

(c) 2010 Playnatic Entertinament 33

 Model-Viewer-Controller

• Зачем это нужно нам?

– Писать документацию в соответствии с этим
паттерном
– Структурировать информацию так, как это
привычно программистам
– Разделять ТЗ по разным частям кода,
который зачастую пишут разные люди

(c) 2010 Playnatic Entertinament 34

 Вопросы?

(c) 2010 Playnatic Entertinament 35