Текущая фаза:
Разработка документации. Смотрите хронологию .
На этой странице содержатся советы для организаций с открытым исходным кодом о том, как оценить и выбрать подходящего технического писателя для своего проектного предложения Google Season of Docs.
Введение
Организации с открытым исходным кодом должны нанять технического писателя для работы над предлагаемым ими проектом. Организации должны найти собственного технического писателя. Технических писателей, заинтересованных в сотрудничестве с организациями, участвующими в Google Season of Docs, можно найти в репозитории Google Season of Docs на GitHub и на канале # Season-of-Docs в разделе Write the Docs Slack.
Начало процесса
Рекомендуется начать процесс поиска технического писателя, как только вы решите принять участие в сезоне документации Google.
Оценка технического писателя
Рекомендуется запросить примеры ранее разработанной документации у технических авторов, которых вы рассматриваете, чтобы вы могли оценить их навыки и опыт технического написания.
Навыки и опыт технического письма
Изучите предыдущий опыт технического писателя. В идеале технический писатель должен иметь некоторый опыт написания технической документации для индустрии программного обеспечения. Одна из целей Google Season of Docs — дать техническим писателям возможность участвовать в разработке продуктов, ориентированных на разработчиков. По этой причине не обязательно, чтобы у автора был опыт работы с API, SDK или другими платформами разработчиков, даже если ваш проект ориентирован на аудиторию разработчиков.
Сосредоточьтесь на языковых и коммуникативных навыках. Оцените предыдущую работу технического писателя с этой точки зрения. Самое главное: можете ли вы понять, что написал человек? Если вы хотите провести углубленный обзор языка работы технического писателя, обратите внимание на последовательность пунктуации и формулировок, правильность орфографии и понятный язык. Формулировка простая или сложная? Короткие ли предложения или они продолжаются до тех пор, пока за ними не становится трудно следовать?
Обратите внимание на дизайн и верстку документа. Проверьте общий макет образца(ов) документа. Логичен ли дизайн? Можете ли вы легко ориентироваться в документе или наборе документации? Есть ли дублирование контента или есть явные пробелы?
Приглашаем на работу технического писателя
Организации должны нанять технического писателя и заполнить форму подтверждения найма технического писателя, ссылка на которую приведена ниже, до 22 мая 2024 года, 18:00 UTC .
Подтверждение формы найма технического писателя
Обязательно обсудите компенсацию и график выплат с техническим писателем до приема на работу. Мы рекомендуем организациям составить график платежей вместе с техническими писателями на основе этапов проекта, включая оплату при запуске проекта. При создании графика платежей учитывайте даты платежей, которые происходят только два раза в течение всей программы, и суммы.
Примечание. Организации, которые не наняли технического писателя и предоставили форму подтверждения найма технического писателя до 22 мая 2024 г., 18:00 UTC, не получат средства в первую дату выплаты.