Итак, вам нужно документировать API…

09.09.2016

Что такое API, для чего используется, зачем и как начать его документировать, какие инструменты использовать, как взаимодействовать с коллегами, какие существуют основные принципы. Очень полезная статья для технических писателей, которые хотят роста. Начинайте документировать API, разберитесь в этом – и карьерный рост вам обеспечен! Получить первое представление вам поможет эта статья. Автор – Лоис Паттерсон (Lois Patterson), технический писатель API из компании Global Relay (Канада).

Тяжело отследить, сколько раз API (Application Programming Interfaces, интерфейсы программирования приложений) сопровождают нашу жизнь каждый день или даже каждый час. Когда проходит ваша транзакция в PayPal или когда вас подбирает водитель Uber, само по себе API невидимо, и это более чем типично для пользовательского программного обеспечения. API используется даже тогда, когда вы встраиваете YouTube-видео в запись WordPress. При наличии сотен тысяч общедоступных API, доступных широчайшему кругу пользователей, компании находятся под большим давлением, чтобы их API были легки и удобны для использования. Не будет сюрпризом то, что рост количества вакансий, связанных с документированием API, огромен — он показывает разогретый рынок для технических писателей, которые специализируются на документировании API. Читать дальше…

Создаём для пользователей успешный информационный интерфейс

22.04.2016

София Маркс рассказывает, как создать успешный пользовательский интерфейс. Для чего это нужно? Это поможет сократить расходы на документацию, повысить доверие пользователя к продукту, а следовательно, обойти конкурентов на рынке. И обратите внимание – хоть статья и рассказывает про интерфейсы к софту, основные принципы относятся абсолютно к любому продукту.

Что такое информационный интерфейс?

Представьте, что вы за рулем новенького Acura TL. Это ваш первый автомобиль, вам нравится им управлять. На приборной панели появляется значок с ярко-оранжевым восклицательным знаком. Что это значит? Вы паникуете. Машина перегрелась? Двигатель собирается взорваться? Надо съехать на обочину? Или игнорировать значок и надеяться на лучшее?

А если бы у вас появился вот такой значок? Были бы вы спокойнее? Добавление небольшого текста о том, что автомобиль требует обслуживания после 10000 миль пробега, добавляет ясности и показывает, что сообщение является важным, но не срочным. Читать дальше…