Текущая фаза:
Программа «Сезон документации 2019» завершилась 6 марта 2020 г. См . график .
Вот несколько рекомендаций для организаций с открытым исходным кодом о том, как работать с техническим писателем, которого вы наставляете в Season of Docs:
- Познакомьте технического писателя с миром открытого исходного кода и своим сообществом.
- Помогите техническому писателю использовать инструменты и процессы, необходимые для участия в вашем проекте.
- Подробно объясните свой продукт, чтобы технический писатель получил четкое концептуальное представление о продукте. Это может помочь техническому писателю чувствовать себя более уверенно и более авторитетно при написании статей для проекта.
- Опишите потребности вашей аудитории, то есть потребности разработчиков, использующих ваш продукт, и/или других групп, использующих этот продукт.
- Поделитесь с техническим писателем важными вариантами использования, чтобы помочь ему разработать необходимую документацию.
- Пройдитесь по коду, когда техническому писателю необходимо его понять, прежде чем писать документацию.
- Свяжите технического писателя с необходимыми экспертами в данной области. То есть разработчики или другие участники проекта, ответственные за те аспекты вашего продукта, которые будут охватываться в документации.
- Убедитесь, что технический писатель получает необходимое время и ресурсы от экспертов в данной области и любых других членов сообщества.
- Поработайте с техническим писателем, чтобы добавить в документацию осмысленные примеры кода, где это необходимо.
Что следует иметь в виду
Наставники по открытому исходному коду в Season of Docs не обязательно являются техническими писателями. Наставникам не обязательно иметь навыки документирования. Технические писатели привносят эти навыки в проект и в отношения наставничества.
Вместо этого наставники делятся своими знаниями о своем сообществе с открытым исходным кодом, продукте, а также процессах и инструментах, которые использует проект с открытым исходным кодом.
Важным результатом наставнических отношений должно стать то, что технический писатель получит полезный и успешный опыт участия в Сезоне документации этого года. Удачный опыт повышает шансы на то, что технический писатель продолжит вносить свой вклад в проект с открытым исходным кодом после закрытия сезона документации в этом году, и что другие технические писатели с энтузиазмом отнесутся к работе с открытым исходным кодом.