Текущая фаза:
Программа «Сезон документации 2021» завершилась 14 декабря 2021 г. См. график .
Используйте эти заголовки шаблонов, чтобы создать собственный отчет о тематическом исследовании.
Заголовок
Организация или проект: название организации (ссылка на страницу или сайт Season of Docs вашей организации)
Описание организации: презентация, дающая краткий обзор того, чем занимается ваша организация или проект.
Авторы: по желанию: укажите авторов тематического исследования; используйте имена пользователей, если требуется
Постановка задачи
Какую проблему вы пытались решить с помощью новой или улучшенной документации?
Краткое содержание предложения
Краткое изложение вашего первоначального организационного предложения. Если возможно, дайте ссылку на страницу предложения на сайте вашего проекта.
Описание Проекта
Создание предложения
Как вы пришли к своему предложению Season of Docs? Какой процесс использовала ваша организация для принятия решения по идее? Как вы собирали и учитывали обратную связь?
Бюджет
Включите небольшой раздел о своем бюджете. Как вы оценили работу? Были ли непредвиденные расходы? В итоге вы потратили меньше суммы гранта? Были ли у вас другие средства помимо Season of Docs, которые вы могли использовать?
Участники
Кто работал над этим проектом (используйте имена пользователей по запросу участников)? Как вы нашли и наняли технического писателя? Как вы находили других волонтеров или платных участников? Какие роли у них были? Кто-нибудь бросил? Что вы узнали о рекрутинге, коммуникациях и управлении проектами?
График
Дайте краткий обзор графика вашего проекта (укажите предполагаемую дату окончания или промежуточные этапы, если проект продолжается).
Полученные результаты
Что было создано, обновлено или иным образом изменено? Включите ссылки на опубликованную документацию, если таковая имеется. Были ли в предложении какие-либо результаты, которые не были реализованы? Перечислите их также.
Метрики
Какие показатели вы выбрали для измерения успеха проекта? Удалось ли вам собрать эти показатели? Хорошо или плохо коррелировали показатели с результатами, которые вы хотели получить от проекта? Изменились ли ваши показатели после вашего предложения?
Анализ
Что прошло хорошо? Что было неожиданным? С какими препятствиями или неудачами вы столкнулись? Считаете ли вы свой проект успешным? Почему или почему нет? (Если еще слишком рано говорить об этом, объясните, когда вы рассчитываете оценить успех своего проекта.)
Краткое содержание
В 2–4 абзацах обобщите свой опыт работы над проектом. Подчеркните, чему вы научились и что бы вы хотели сделать по-другому в будущем. Какой совет вы бы дали другим проектам, пытающимся решить аналогичную проблему с документацией?
Приложение
Если у вас есть другие материалы, на которые вы хотели бы дать ссылку (например, если вы заключили контракт на работу со своим техническим писателем, которым хотите поделиться, или шаблоны для вашего проекта документации, или другие открытые ресурсы документации, вы можете список и ссылку на них здесь). Приложение также является хорошим местом для перечисления ссылок на любые инструменты документации или ресурсы, которые вы использовали, или местом для выражения благодарности или признательности, которые могут не вписаться в разделы выше.