Выбор технического писателя

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

На этой странице содержатся советы для организаций с открытым исходным кодом о том, как оценить и выбрать подходящего технического писателя для своего проектного предложения Season of Docs.

Введение

Организации с открытым исходным кодом должны нанять технического писателя для работы над предлагаемым ими проектом. Организации должны найти собственного технического писателя. Технических писателей, заинтересованных в работе с организациями, участвующими в Season of Docs, можно найти в репозитории Season of Docs на GitHub и на канале # Season-of-Docs в Write the Docs Slack.

Оценка технического писателя

Рекомендуется запросить примеры ранее разработанной документации у технических авторов, которых вы рассматриваете, чтобы вы могли сосредоточиться на оценке их навыков и опыта технического написания.

Навыки и опыт технического письма

  • Изучите предыдущий опыт технического писателя. В идеале технический писатель должен иметь некоторый опыт написания технической документации для индустрии программного обеспечения. Одна из целей Season of Docs — дать техническим писателям возможность участвовать в разработке продуктов, ориентированных на разработчиков. По этой причине не обязательно, чтобы у автора был опыт работы с API, SDK или другими платформами разработчиков, даже если ваш проект ориентирован на аудиторию разработчиков.

  • Сосредоточьтесь на языковых и коммуникативных навыках. Оцените предыдущую работу технического писателя с этой точки зрения. Самое главное: можете ли вы понять, что написал человек? Если вы хотите провести углубленный анализ языка работы технического писателя, обратите внимание на последовательность пунктуации и формулировок, правильность орфографии и понятный язык. Формулировка простая или сложная? Короткие ли предложения или они продолжаются до тех пор, пока за ними не становится трудно следовать?

  • Обратите внимание на дизайн и верстку документа. Проверьте общий макет образца(ов) документа. Логичен ли дизайн? Можете ли вы легко ориентироваться в документе или наборе документации? Есть ли дублирование контента или есть явные пробелы?