Техническое письмо для разработчиков программного обеспечения

Ясное общение так же важно, как и чистый код при создании масштабируемого программного обеспечения. Этот курс, основанный только на тексте, поможет вам преобразовать сложные технические концепции в удобную для чтения и эффективную документацию для членов команды, заинтересованных сторон и внешних пользователей. Вы научитесь подходить к написанию с той же точностью, что и к программированию. Что вы узнаете: - Понять основные принципы четкого, лаконичного и ориентированного на разработчика технического письма - Структурировать и писать эффективные файлы README, документы по архитектуре системы и примечания к выпуску - Разработать четкую документацию API с использованием современных стандартов и Markdown - Применять рабочие процессы docs-as-code для управления документацией с использованием систем управления версиями - Эффективно писать для различных аудиторий, от нетехнических деловых партнеров до коллег-инженеров Начиная с ключевой терминологии и психологии технической коммуникации, вы пройдете через практические структуры написания и упражнения по рефакторингу. Этот курс разработан специально для разработчиков программного обеспечения и инженерных руководителей, без предварительного опыта написания. Начните писать документацию, которую ваша команда будет действительно любить читать.