Хороший материал об ошибках, которые допускают начинающие гейм-дизайнеры при написании документации.
https://gdcuffs.com/7-ways-to-fuck-up/
Основные тезисы:
1. Дизайнер пишет документацию не для себя, а для команды;
2. Не пишите всё в одном документе. Дробите ГДД на разные документы, с разными фичами;
3. Ведите каталог документации с ссылками и кратким описанием документов;
4. Следите за структурой всей документации и внутри документов;
5. Оформление:
— Это отражение образа мысли дизайнера;
— Облегчает восприятие большого объёма информации, тратьте время на него;
6. Визуальные референсы — это ваши союзники. Используйте картинки и даже видео для того, чтобы показать, что вы хотите получить;
7. Пишите и упрощайте. Чем меньше воды в тексте, тем:
— Понятнее будет ваша идея;
— Быстрее будет донесена до команды;
8. Стремитесь к однозначным формулировкам. Если что-то может быть понято неверно — оно будет понято неверно;
9. Конкретные значения параметров в тексте оставляют впечатление, что это незыблемая константа. Отмечайте, где параметр изменяемый;
10. Перечитывайте документацию через 1-2 дня после написания. С замыленным взглядом сложно увидеть проблемы;
11. Следите за названиями документов и файлов. Как файл назовёшь, так быстро его и потеряешь.
12. Общайтесь с командой
— Требуйте с них фидбек. Он поможет сделать вашу документацию лучше;
— Слушайте их идеи. Любой человек в команде может предложить отличные вещи для проекта;
13. Исправляйте вашу документацию, держите её в актуальном состоянии;
14. Не оценивайте вашу документацию по размеру (количеству документов, страниц). В шести страничном документе может быть сплошная вода, а программисту хватит описания на трёх;
Подписывайтесь на @disdoc
https://gdcuffs.com/7-ways-to-fuck-up/
Основные тезисы:
1. Дизайнер пишет документацию не для себя, а для команды;
2. Не пишите всё в одном документе. Дробите ГДД на разные документы, с разными фичами;
3. Ведите каталог документации с ссылками и кратким описанием документов;
4. Следите за структурой всей документации и внутри документов;
5. Оформление:
— Это отражение образа мысли дизайнера;
— Облегчает восприятие большого объёма информации, тратьте время на него;
6. Визуальные референсы — это ваши союзники. Используйте картинки и даже видео для того, чтобы показать, что вы хотите получить;
7. Пишите и упрощайте. Чем меньше воды в тексте, тем:
— Понятнее будет ваша идея;
— Быстрее будет донесена до команды;
8. Стремитесь к однозначным формулировкам. Если что-то может быть понято неверно — оно будет понято неверно;
9. Конкретные значения параметров в тексте оставляют впечатление, что это незыблемая константа. Отмечайте, где параметр изменяемый;
10. Перечитывайте документацию через 1-2 дня после написания. С замыленным взглядом сложно увидеть проблемы;
11. Следите за названиями документов и файлов. Как файл назовёшь, так быстро его и потеряешь.
12. Общайтесь с командой
— Требуйте с них фидбек. Он поможет сделать вашу документацию лучше;
— Слушайте их идеи. Любой человек в команде может предложить отличные вещи для проекта;
13. Исправляйте вашу документацию, держите её в актуальном состоянии;
14. Не оценивайте вашу документацию по размеру (количеству документов, страниц). В шести страничном документе может быть сплошная вода, а программисту хватит описания на трёх;
Подписывайтесь на @disdoc
