Home

Материалы, размещенные в данном репозитории являются вольным переводом курса Documenting APIs: A guide for technical writers составленного Томом Джонсоном, техническим писателем Amazon.

Перевод курса по мере возможностей.

Цель перевода курса:

• пройти курс, научиться документировать API, повысить свои soft skills техписателя;
• освежить знания английского языка;

Курс состоит из модулей:

1. Введение в REST API (Introduction to REST APIs)
2. Использование API в роли разработчика (Using an API like a developer)
3. Документирование конечных точек (Documenting API endpoints)
4. Спецификация OpenAPI и Swagger (OpenAPI specification and Swagger)
5. Тестирование документации (Testing API documentation)
6. Безадресные разделы (Non-reference API topics)
7. Публикация документации (Publishing your API documentation)
8. Работа технического писателя (Getting a job in API documentation)
9. Исходные библиотеки API (Native library APIs)
10. Глоссарий API и источники (API glossary and resources)