<Название организации>: <Год> Пример использования Google Season of Docs
Название организации или проекта:
Ссылка на сезон Документов:
Описание организации: презентация из 1–2 предложений, содержащая краткий обзор того, чем занимается ваша организация или проект.
Авторы: укажите авторов тематического исследования; используйте имена пользователей, если требуется (необязательно)
Краткое содержание
Заполните следующую таблицу и дайте краткие ответы на вопросы. Более подробную информацию вы можете предоставить в последующих разделах. Мы рекомендуем вам сначала написать подробные разделы, а затем вернуться к написанию резюме.
| # Технические писатели | Часы работы проекта TW | Бюджет | % проекта завершено |
|---|---|---|---|
| ## | ## | $X | Х% |
Какую проблему вы пытались решить? И как вы пытались это решить?
Каковы были результаты вашего проекта?
Что прошло хорошо? И что бы вы сделали по-другому?
Какой совет вы бы дали другим проектам, пытающимся решить аналогичную проблему с документацией?
Описание проекта
Опишите проект, заполнив следующие разделы.
Предложение проекта
Предоставьте краткое описание вашего предложения и ссылку на страницу предложения на сайте вашего проекта.
Процесс создания предложения
Как вы пришли к своему предложению Google Season of Docs? Какой процесс использовала ваша организация для принятия решения по идее? Как вы собирали и учитывали обратную связь? Кто участвовал в процессе? Сколько времени это заняло?
Бюджет
Ответьте на вопросы в следующей таблице.
| Сколько денег вы просили? | |
| Как вы пришли к такой оценке? | |
| Сколько часов работы вы заложили в проект? | |
| Сколько часов работы на самом деле потребовалось для проекта? | |
| Какие еще расходы вы включили в свой бюджет? | |
| Сталкивались ли вы с какими-либо бюджетными сюрпризами в ходе проекта (например, с неправильным расчетом)? Если да, пожалуйста, объясните. |
Набор технических писателей
Как вы нашли и наняли технического писателя? Процесс прошел хорошо? Остались ли они на время проекта?
Другие участники
Кто еще работал над этим проектом (используйте имена пользователей по запросу участников)? Как вы их завербовали? Какие роли у них были? Остались ли они на время проекта?
Хронология
Дайте краткий обзор графика вашего проекта (укажите предполагаемую дату окончания или промежуточные этапы, если проект продолжается). Требовался ли первоначальный график корректировки?
Результаты
Заполните следующие таблицы, чтобы описать, что было создано, обновлено или иным образом изменено в ходе проекта. Включите как запланированные, так и незапланированные результаты. Обязательно укажите дела, которые были запланированы, но не выполнены.
Запланированные результаты
Соответствующие ссылки могут включать опубликованные документы, запросы на включение или другие артефакты.
| Результат | % Полный | Соответствующие ссылки | Примечания |
|---|---|---|---|
| Результат №1 | |||
| … | |||
| Результат № N |
Незапланированные результаты
Были ли созданы какие-либо результаты, которые не были запланированы в начале проекта? Если да, пожалуйста, объясните.
Метрики
Какие показатели вы выбрали для измерения успеха проекта? Удалось ли вам собрать эти показатели? Заметили ли вы какие-либо изменения в результате проекта? Добавляли ли вы или удаляли какие-либо показатели после вашего предложения? Как часто вы планируете собирать показатели в будущем?
Анализ
Расскажите вкратце о том, как прошел проект. Был ли проект успешным? Почему или почему нет? Или когда вы сможете судить об успехе? Сталкивались ли вы с какими-либо неожиданными препятствиями или неудачами? Привел ли проект к появлению каких-либо новых или обновленных процессов или процедур в вашей организации?
Извлеченные уроки
Используйте следующие таблицы, чтобы выделить извлеченные уроки – как то, что прошло хорошо, так и то, что можно было бы улучшить. Используйте перечисленные категории тем по мере необходимости или добавляйте свои собственные. При необходимости вы можете иметь несколько строк для данной темы. Эти извлеченные уроки войдут в наш сводный список лучших практик для проектов документации.
Что прошло хорошо?
За извлеченные уроки добавьте свои собственные или поставьте «плюс один» любому из существующих рекомендаций Google Season of Docs Best Practices .
| Тема | Что мы сделали | Урок усвоен |
|---|---|---|
| Бюджет | ||
| Коммуникация | ||
| Наставничество | ||
| Метрики | ||
| Регистрация | ||
| Участники | ||
| Результаты проекта | ||
| Управление проектом | ||
| Рекрутинг и найм | ||
| … | ||
| <Другие темы по мере необходимости> | ||
Что можно улучшить?
За извлеченные уроки добавьте свои собственные или поставьте «плюс один» любому из существующих рекомендаций Google Season of Docs Best Practices .
| Тема | Что мы сделали | Что бы мы сделали по-другому | Урок усвоен |
|---|---|---|---|
| Бюджет | |||
| Коммуникация | |||
| Наставничество | |||
| Метрики | |||
| Регистрация | |||
| Участники | |||
| Результаты проекта | |||
| Управление проектом | |||
| Рекрутинг и найм | |||
| … | |||
| <Другие темы по мере необходимости> | |||
Приложение
Если у вас есть другие материалы, на которые вы хотели бы дать ссылку (например, если вы заключили контракт на работу со своим техническим писателем, которым хотите поделиться, или шаблоны для вашего проекта документации, или другие открытые ресурсы документации, вы можете список и ссылку на них здесь). Приложение также является хорошим местом для перечисления ссылок на любые инструменты документации или ресурсы, которые вы использовали, или местом для выражения благодарности или признательности, которые могут не вписаться в предыдущие разделы.