Документация по API и почему это важно

• В мире насчитывается 24,3 миллиона активных разработчиков программного обеспечения, что больше, чем население Флориды или Австралии.  

• API - это инструменты, которые помогают программному обеспечению взаимодействовать, и они повсюду.  

• API-интерфейсы - это продукт для потребления, и разработчики должны уделять столько же усилий их созданию и распространению, сколько и созданию программного обеспечения.  

• API состоит из кода и документации по его использованию.  

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

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

• Начинайте с начального уровня, чтобы охватить всех пользователей.  

• Следите за ходом работы с существующими пользователями и их опытом.  

• Придерживайтесь известной схемы для удобства использования.  

• Обновляйте документы, чтобы они соответствовали требованиям актуальности.  

• Наймите человека, который знает, как писать технический контент, для создания продающих текстов и учебных пособий.  

• Маркетологи и менеджеры по продуктам во всем мире усердно работают над тем, чтобы заставить людей использовать их продукты.  

• В мире, где API-интерфейсы также являются продуктами, эти усилия должны распространяться и на создание API.  

• Независимо от того, хотите ли вы, чтобы ваш внутренний API был полезен вашим сотрудникам или извлекал выгоду из сервиса, который вы публикуете, придерживайтесь его и относитесь к API с уважением, которого он заслуживает.  

• Какие аспекты технической документации вы хотите, чтобы мы объяснили в следующий раз?