Создание тематического исследования

Текущая фаза:
Программа «Сезон документации 2021» завершилась 14 декабря 2021 г. См. график .

В рамках Сезона документации 2021 года организации должны представить окончательную оценку и тематическое исследование. Используйте наш шаблон тематического исследования и образец тематического исследования в качестве руководства для создания тематического исследования вашего собственного проекта.

Окончательная форма оценки будет доступна не менее чем за месяц до 30 ноября 2021 г. в 18:00 UTC.

Обзор тематического исследования

Шаблон тематического исследования будет включать в себя следующие разделы:

  • Постановка проблемы: какую проблему вы пытались решить с помощью новой или улучшенной документации?
  • Аннотация предложения: краткое изложение исходного организационного предложения.
  • Описание проекта: повествовательное описание вашего проекта. Включать:
    • Как вы создали свое предложение (и ссылку на исходную страницу идей проекта).
    • Как вы набирали и отбирали технического писателя или других участников.
    • Кто работал над проектом (используйте имена пользователей по запросу участников).
    • Сколько времени потребовалось для завершения проекта (если он был завершен).
    • Что прошло хорошо?
    • Что было неожиданным? С какими препятствиями или неудачами вы столкнулись?
    • Какая документация была создана, обновлена, улучшена или удалена?
  • Привел ли этот проект к появлению каких-либо новых или обновленных процессов или процедур в вашей организации?
  • Метрики:
    • Какие показатели были выбраны для измерения успешности проекта?
    • Удалось ли вам собрать эти показатели?
    • Соответствовали ли они поведению или критериям, которые вы ожидали?
    • Изменились ли выбранные вами показатели? Вы удалили или добавили какие-либо показатели?
    • По вашим метрикам ваш проект успешен? (Возможно, еще слишком рано говорить об этом.)
    • Как часто вы планируете собирать показатели в будущем?
  • Краткое содержание:
    • В 2–4 абзацах обобщите свой опыт работы над проектом. Что ты изучал? Что бы вы сделали по-другому в будущем? Какой совет вы бы дали проектам, пытающимся решить подобную проблему с помощью документации?

Руководство по тематическому исследованию

  • Ведение еженедельного журнала обновлений проекта поможет вам подготовить практический пример. Каждую неделю записывайте ход проекта (включая ссылки на запросы на включение, проблемы или беседы, где это полезно), что прошло хорошо (или не очень), что вы узнали и задавали вопросы.
  • При написании тематического исследования будьте любезны. Избегайте обвинений и сохраняйте конструктивность. Помните, что тематические исследования являются общедоступными!
  • Используйте в своем тематическом исследовании тот же тон, что и в сообщении в блоге или учебном пособии; не будьте слишком формальными.