API-писатель
![]() | Эта статья включает список литературы , связанную литературу или внешние ссылки , но ее источники остаются неясными, поскольку в ней отсутствуют встроенные цитаты . ( Апрель 2009 г. ) |
Автор API — это технический писатель , который пишет документы, описывающие интерфейс прикладного программирования (API). Основная аудитория включает программистов, разработчиков, системных архитекторов и системных дизайнеров.
Обзор
[ редактировать ]API — это библиотека , состоящая из интерфейсов, функций, классов , структур, перечислений и т. д. для создания программного приложения. Он используется разработчиками для взаимодействия и расширения программного обеспечения. API для данного языка программирования или системы может состоять из определяемых системой и определяемых пользователем конструкций. По мере увеличения количества и сложности этих конструкций разработчикам становится очень утомительно запоминать все определенные функции и параметры. Следовательно, авторы API играют ключевую роль в создании программных приложений.
Из-за технической тематики авторы API должны понимать исходный код приложения в достаточной степени, чтобы извлечь информацию, необходимую для документов API. Авторы API часто используют инструменты, которые извлекают документацию по программному обеспечению, помещенную программистами в исходный код в структурированном виде, сохраняя связи между комментариями и программными конструкциями, которые они документируют.
Авторы API также должны понимать программный продукт и документировать новые функции или изменения в рамках новой версии программного обеспечения. График выпусков программного обеспечения варьируется от организации к организации. Авторы API должны хорошо понимать жизненный цикл программного обеспечения и интегрироваться в жизненный цикл разработки систем (SDLC).
Авторы API в США обычно следуют Чикагскому руководству по стилю в отношении грамматики и пунктуации . [ нужна ссылка ]
Квалификация
[ редактировать ]Авторы API обычно обладают сочетанием навыков программирования и языков; многие авторы API имеют опыт программирования или написания технических статей .
- Опыт компьютерного программирования (знание C , C++ , Java , PHP или других языков программирования )
- Знание стандартов форматирования, таких как Doxygen , Javadoc , OpenAPI или DITA.
- Знание редакторов и инструментов, таких как FrameMaker.
- Отличные коммуникативные и письменные навыки для взаимодействия с разработчиками
Опытные авторы API/ пакетов разработки программного обеспечения (SDK) могут легко стать писателями -программистами .
Процесс написания API
[ редактировать ]Процесс написания API обычно делится на анализ и понимание исходного кода , планирование, написание и проверку. Часто бывает, что этапы анализа, планирования и написания не происходят строго линейно.
Критерии написания и оценки различаются в разных организациях. Некоторые из наиболее эффективных документов API написаны теми, кто способен адекватно понимать работу конкретного приложения, чтобы они могли связать программное обеспечение с пользователями или различные конструкции компонентов с общей целью программы. Авторы API также могут нести ответственность за создание документации по продукту для конечных пользователей .
Хотя справочная документация может создаваться автоматически для обеспечения полноты, документация, которая поможет разработчикам начать работу, должна быть написана профессиональным автором API и проверена экспертами в данной области. [1] Это помогает гарантировать, что разработчики понимают ключевые концепции и могут быстро приступить к работе.
Продукт
[ редактировать ]Авторы API создают документы, которые включают в себя:
- Справочные руководства по API
- Руководства программистов
- Руководства для разработчиков
- Руководства по администрированию
- Руководства по установке
- Руководства по внедрению и интеграции
См. также
[ редактировать ]Ссылки
[ редактировать ]- ^ Джейкобсон, Дэниел (2011). API: руководство по стратегии . О'Рейли. п. 101. ИСБН 9781449321642 .