Текущая фаза:
Разработка документации. Смотрите хронологию .
На этой странице приведены некоторые вопросы, которые следует учитывать при заключении соглашения с техническим писателем для Google Season of Docs. Это не юридическая консультация или исчерпывающий список всех возможных моментов, которые следует учитывать при заключении соглашений о написании технических документов для проектов с открытым исходным кодом. В зависимости от потребностей вашей организации или проекта вы можете проконсультироваться со своим юрисконсультом, прежде чем нанимать технического писателя.
Объем работ
- Составьте список работ, предусмотренных вашим соглашением. Будьте как можно более конкретными. Например, вместо «Документация API» составьте список того, какие конечные точки необходимо задокументировать и какую информацию необходимо включить, например образец команды Curl или список параметров.
- Как вы узнаете, что часть контента «закончена»?
- Другие вещи, которые следует учитывать:
- Кому будут принадлежать авторские права на произведение? Под какой лицензией он будет выпущен (они разные!)? Какую оценку получит технический писатель (упоминание на сайте, указание как участник и т. д.)? Что, если в будущем контент потребуется повторно лицензировать? Например, если вы ожидаете, что технический писатель подпишет лицензионное соглашение для участников вашего проекта с открытым исходным кодом, вам следует сообщить об этом.
- Если вы ожидаете, что технический писатель будет участвовать в нескольких проверках, укажите это. Например, вы можете заявить, что ожидаете первого черновика, затем второго этапа для решения технических проблем, а затем окончательного этапа корректуры.
- Если вы ожидаете, что технический писатель предоставит контент в определенном формате, например Markdown, включите это в свое соглашение.
- Есть ли в вашем проекте рекомендации по использованию генеративного ИИ для создания документации или кода? Убедитесь, что эти рекомендации переданы вашему техническому писателю.
Компенсация
- Согласуйте с техническим писателем график платежей, привязанный к точным датам и результатам.
- Будете ли вы платить аванс в начале работы?
- Что произойдет, если работу невозможно будет использовать или принять (из-за того, что приоритеты проекта изменились или из-за отчисления рецензента и т. д.)? Можете ли вы заплатить «комиссию», чтобы компенсировать время, потраченное техническим писателем?
- Кто будет нести ответственность за любые комиссии за конвертацию валюты, связанные с выбранным способом оплаты?
Коммуникация
- Ожидаете ли вы, что технический писатель будет доступен для видеозвонков или встреч?
- Какие каналы связи вы будете использовать и каково ожидаемое время ответа? Например, если вы ожидаете, что технический писатель ответит на электронные письма (или сообщения в Slack) в течение дня, укажите это явно.
- К кому из проекта технический писатель может обратиться по различным вопросам, например, о проблемах с оплатой, необходимости проверки, проблемах с разблокировкой инструментов или каналов или других блокировщиках?
- Существует ли определенный процесс, который писатель должен использовать для подачи своей работы или получения отзывов или рецензий?
Инструменты
- Какие инструменты (или версии инструментов) необходимо использовать техническому писателю для создания своей работы?
- Кто отвечает за помощь техническому писателю в настройке, получении доступа или разрешений?
Разрешение разногласий
- Как вы будете разрешать разногласия по поводу качества работы технического писателя? За кем остается последнее слово?
- Какова будет процедура освобождения технического писателя от проекта? Например, просрочка трёх сроков подряд или сдача работы неприемлемого качества. При обеспечении соблюдения этого процесса рассмотрите возможность четкого указания следующих шагов («Мы ожидаем, что запрос на включение первого черновика будет отправлен к следующей пятнице», а не «Пожалуйста, отправьте свою работу как можно скорее»).
- Если техническому писателю придется уйти, как ему сообщить об этом? Если возможно, следует ли им направить уведомление, создать документ о передаче обслуживания или провести телеконференцию о передаче обслуживания?
- Не забудьте учесть обязательства проекта перед техническим писателем. Например, если наставники вашего проекта уходят и не могут быть заменены, или если обещанные обзоры не могут быть завершены, рассмотрите возможность выплаты части оставшихся средств техническому писателю, даже если проект не может быть завершен, чтобы компенсировать автору его время.
- Прямо укажите, что технический писатель обязан соблюдать Кодекс поведения проекта, и дайте ссылку на ваш процесс обеспечения соблюдения Кодекса поведения. Вы можете четко указать, что нарушения CoC приведут к прекращению проекта и лишению оплаты за любую невыполненную работу.