Немного об авторе курса: Том Джонсон, в настоящее время живет в Калифорнийском Bay Area Сан-Франциско (Саут-Бэй, или Силиконовая долина) и работает в Amazon в Саннивейле. В основном пишет документацию для сторонних разработчиков, создающих приложения для Amazon Appstore, в первую очередь связанных с Fire TV.
Большинство людей знают его по блогу I’d Rather Be Writing, который был активным онлайн-блогом для технических специалистов в течение последнего десятилетия.
Как и большинство технических писателей, автор столкнулся с этой профессией после работы в других областях. Сначала получил степень бакалавра по английскому языку и степень магистра по литературе, а затем начал свою карьеру в качестве учителя. После работы в области преподавания автор перешел на маркетинговый копирайтинг, а затем стал техническим писателем (в основном по финансовым причинам).
Несмотря на первоначальное неприятие идеи технического писательства (думал, что это будет скучно), Том Джонсон понял, что ему действительно нравится данная профессия - гораздо больше, чем копирайтинг. Она сочетает в себе мою любовь к письму и увлечение технологией. Получается игра с инструментами и производство всех аспектов контента, от дизайна до стилей и публикации рабочих процессов.
Несколько лет автор работал обычным техническим писателем, в основном документируя приложения с пользовательскими интерфейсами. Однажды его организация решила уволить команду технических писателей. После этого, и, исходя из склонности к работе с инструментами, он решил направить карьеру на рынок технического письма, который был более востребован: документация для разработчиков, в частности документация API. Он также переехал в Силиконовую долину, чтобы быть в центре технологий.
Задокументировал свой первый API в стартапе геймификации, а затем перешел на другой полу-стартап, чтобы продолжить с документацией API. После этого перестал работать с приложениями, которые имели пользовательские интерфейсы, и аудитория его документов поменялась: теперь это были в основном разработчиками. Документация для разработчиков была новым полем для исследований с различными инструментами, ожиданиями, целями и результатами.
Не имея опыта в программировании, автора всегда немного влекло в ту сторону. Будучи учителем, он создал свой собственный интерактивный сайт. В роли технического писателя он часто настраивал или взламывал писательские инструменты и производимые ими артефакты. Было интересно учиться и экспериментировать с новыми технологиями. Документация разработчика очень интересна, и это нравится.
Тем не менее, автор ни разу не программист. Техническому писателю глубокие технические знания полезны, но не всегда необходимы, так как они, как правило, слишком специализированы и приходят за счет других навыков и знаний. Самое важное - это способность узнавать что-то новое в разных областях и продуктах, даже если это поначалу сложно. А затем сформулировать знания в удобной форме.
Вы взялись за этот курс, вероятно, потому что хотите развить свои навыки и знания, чтобы расширить свои возможности на работе, повысить конкурентоспособность своего набора навыков или, возможно, выяснить, как задокументировать новый API, который развертывает ваша компания.
Вы находитесь в правильном месте. К тому времени как вы закончите этот курс, у вас будет четкое понимание того, как документировать API. Вы будете знакомы с правильными инструментами, подходами и методами, необходимыми для успешного создания документации для разработчиков.