Войти
Разработчик API- это технический писатель, который пишет документы, описывающие интерфейс прикладного программирования (API). Основная аудитория - программисты, разработчики, системные архитекторы и системные дизайнеры.
API это библиотека, состоящая из интерфейсов, функций, классов, структур, перечислений и т. д. для создания программного приложения. Он используется разработчиками для взаимодействия с программным обеспечением и его расширения. API для данного языка программирования или системы может состоять из определяемых системой и определяемых пользователем конструкций. Поскольку количество и сложность этих конструкций увеличивается, разработчикам становится очень утомительно запоминать все функции и определенные параметры. Следовательно, разработчики API играют ключевую роль в создании программного обеспечения приложений.
Из-за технической темы разработчики API должны понимать приложение исходный код в достаточной степени, чтобы извлекать информацию, необходимую для документов API. Разработчики API часто используют инструменты, которые извлекают документацию по программному обеспечению, помещенную программистами в исходный код в структурированном виде, сохраняя связи между комментариями и программными конструкциями, которые они документируют.
Авторы API должны также понимать программный продукт и документировать новые функции или изменения как часть новой версии программного обеспечения. График выпуска программного обеспечения варьируется от организации к организации. Создателям API необходимо хорошо понимать жизненный цикл программного обеспечения и интегрироваться в жизненный цикл разработки систем (SDLC).
Авторы API в США обычно следуют Чикагскому руководству по стилю для грамматики и пунктуации.
Авторы API обычно обладают сочетанием языковых и языковых навыков; многие разработчики API имеют опыт работы в программировании или техническом написании.
Expert API / набор средств разработки программного обеспечения (SDK) могут легко стать программирование писатели.
Процесс написания API обычно делится между анализом и пониманием исходного кода, планированием, написанием и проверкой. Часто этапы анализа, планирования и написания не являются строго линейными.
Критерии написания и оценки различаются в разных организациях. Некоторые из наиболее эффективных документов API написаны теми, кто адекватно способный о f понимание работы конкретного приложения, чтобы они могли связать программное обеспечение с пользователями или различные конструкции компонентов с общей целью программы. Разработчики API могут также отвечать за создание документации по продукту для конечных пользователей.
Хотя справочная документация может создаваться автоматически для обеспечения полноты, документация, которая помогает разработчикам начать работу, должна быть написана профессиональным автором API и проверена экспертами в данной области. Это помогает убедиться, что разработчики понимают ключевые концепции и могут быстро приступить к работе.
Авторы API создают документы, которые включают:
