На этой странице представлена информация о проекте по техническому писательству, принятом для участия в программе Google Season of Docs.
Сводка по проекту
- Организация, разрабатывающая ПО с открытым исходным кодом:
- GDevelop
- Разработчик технической документации:
- Дэвид Тернбулл (David Turnbull)
- Название проекта:
- Разработайте оптимальный процесс обучения для начинающих
- Продолжительность проекта:
- Стандартный срок (3 месяца)
Описание проекта
Шаг 1. Проведите аудит контента
Это означает глубокое погружение в существующую документацию и получение широкого понимания того, как работает GDevelop и что новые пользователи могут найти в нем наиболее увлекательным. Я также буду следовать существующим руководствам и записывать все трудности, с которыми столкнусь.
Шаг 2. Перепишите руководство по началу работы
Когда пользователь читает документацию GDevelop, он, скорее всего, начинает с руководства по началу работы. Но само руководство не очень интересное – в нем просто рассказывается об установке GDevelop, открытии проекта и т. д. Я хочу переписать это руководство, чтобы пользователи могли чего-то достичь, даже если это "что-то" будет небольшим (например, добавление объекта в игру). Также я бы хотел добавить более четкие инструкции по дальнейшим действиям, поскольку в текущем руководстве в конце приведено много ссылок, что может запутать пользователей.
Шаг 3. Улучшите информационную архитектуру
В документации GDevelop есть отличный контент, особенно руководства, но он не всегда представлен наилучшим образом. Используя то, что я узнаю из аудита контента, я хотел бы исследовать, как можно реорганизовать контент и навигацию, чтобы пользователи находили нужный им контент, когда он им нужен.
Другие задачи/возможности обязательно появятся в ходе проекта — как только я начинаю проект по документированию, я не могу не увлечься им, — но мне кажется, что эти шаги закладывают прочный фундамент.