Текущая фаза:
Программа «Сезон документации 2020» завершилась 15 марта 2021 г. См . график .
На этой странице содержатся рекомендации для организаций с открытым исходным кодом о том, как оценивать предложения проектов по техническому написанию и выбирать проекты, которые они хотят курировать в Season of Docs.
Введение
Технические писатели подают свои предложения Season of Docs для работы над проектом с выбранной ими организацией с открытым исходным кодом. Администраторы программы Google направляют предложения организациям с открытым исходным кодом для оценки и выбора проектов. Подробную информацию о необходимых действиях см. в руководстве администратора организации .
Оценка предложений технических писателей
Навыки и опыт технического письма
Изучите предыдущий опыт технического писателя. Предложение технического писателя включает информацию об его последнем опыте технического написания. В идеале кандидат должен иметь некоторый опыт написания технической документации для индустрии программного обеспечения. Одна из целей Season of Docs — дать техническим писателям возможность участвовать в разработке продуктов, ориентированных на разработчиков. По этой причине не обязательно, чтобы у автора был опыт работы с API, SDK или другими платформами разработчиков, даже если ваш проект ориентирован на аудиторию разработчиков.
Сосредоточьтесь на языковых и коммуникативных навыках. Оцените предложение технического писателя с этой точки зрения. Самое главное: можете ли вы понять, что написал человек? Ваша роль как наставника будет заключаться в том, чтобы помогать техническому писателю с процессами, инструментами и кодом с открытым исходным кодом — вам не нужно также просматривать текст полученной документации. Если вы хотите провести углубленный анализ языка предложения, обратите внимание на последовательность пунктуации и формулировок, правильность написания и понятный язык. Формулировка простая или сложная? Короткие ли предложения или они продолжаются до тех пор, пока за ними не становится трудно следовать?
Обратите внимание на дизайн и верстку документа. В рамках своего предложения технический писатель имеет возможность предоставить примеры разработанной им документации. Проверьте общий макет образца(ов) документа. Логичен ли дизайн? Можете ли вы легко ориентироваться в документе или наборе документации? Есть ли дублирование контента или есть явные пробелы?
Предложение
Убедитесь, что предложение соответствует вашим требованиям. Связано ли это предложение с какими-либо проектными идеями, которые вы представили на «Сезоне документации» в этом году? Если технический писатель предложил новую идею, убедитесь, что это предложение соответствует потребностям вашего проекта с открытым исходным кодом и что у вас есть подходящие люди, которые помогут техническому писателю достичь целей предлагаемого проекта.
Ищите энтузиазм и тщательность. Показывает ли предложение, что технический писатель в восторге от проекта? Подумайте, вложили ли они в это предложение свои мысли и усилия, либо проконсультировавшись с вашей организацией на этапе исследования, либо добавив свои собственные мысли о том, как достичь целей проекта.
Часто задаваемые вопросы
Как мы решаем, сколько проектов подавать?
Сосредоточьтесь на одном или двух проектах. Если ваша организация имеет возможность наставлять больше, вы можете отправить больше. Для каждого проекта технического писателя вам нужен как минимум один наставник (предпочтительно два), который будет наставником только этого проекта.
Прочтите информацию о том, как работает распределение слотов Season of Docs.
Как нам выбрать, какое предложение по техническому написанию принять?
Убедитесь, что вы выбрали лучшее из полученных вами предложений технических писателей. То есть выберите предложения, которые лучше всего соответствуют вашим требованиям и которые лучше всего соответствуют рекомендациям по оценке, перечисленным выше.