Искусство API Документации

Это третий из серии курсов для технических писателей, которые хотят научиться писать документацию по API. Первые два курса называются «Изучение технического написания API: JSON и XML для писателей» и «Изучение технического написания API: REST для писателей», и рекомендуется сначала пройти эти курсы, если вы не очень хорошо знакомы с документацией API, и как документировать справочный материал.

Этот курс учит, как писать концептуальную документацию API, такую как обзоры, разделы по началу работы и учебные пособия. По большей части, опыт программирования не требуется, но технические писатели с опытом программирования все равно найдут его полезным.

В дополнение к концептуальному материалу, этот курс охватывает рекомендации для хорошего примера кода, инструменты для создания запросов REST и как найти проект с открытым исходным кодом для документирования как способ попасть в область написания API.

Что такое API?

API (прикладные программные интерфейсы) определяют, как программные системы взаимодействуют друг с другом, а документация по API - это быстро развивающаяся область. Существует острая необходимость в авторах, которые могут понимать API и объяснять их, чтобы разработчики программного обеспечения могли понять, как их использовать. Авторы API получают доступ к новейшим технологиям на высокооплачиваемых должностях.

Что такое концептуальный материал?

Документация API состоит из справочного материала и концептуального материала. Справочный материал описывает детали API: каковы части каждого запроса и ответа или каждого класса и члена. Концептуальный материал ориентирует разработчиков так, чтобы им было легко начать работу с новым API.

Что в этом курсе?

К концу курса вы поймете, как написать хороший концептуальный материал по API, как выполнять вызовы REST с использованием инструментов GUI и командной строки, а также как найти проект с открытым исходным кодом для документирования. В этом курсе вы найдете:

• 8 видео, которые:
  • Опишут, как написать хороший концептуальный материал
  • Предоставят рекомендации для хорошего примера кода
  • Демонстрируют, как использовать инструменты для выполнения вызовов REST
  • Приводят вам примеры того, как найти проекты с открытым исходным кодом в Интернете
• 2 практических упражнения, которые помогут вам выполнить запросы REST с помощью инструментов
• PowerPoint презентации как ресурс для каждой видео лекции
• PDF с ресурсами для поиска проектов с открытым исходным кодом

Курс занимает приблизительно 1 час 30 минут, в зависимости от того, насколько быстро вы выполняете упражнения.