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