Как стать автором
Обновить
2
0
Карим Аминов @KarimAminov

Head of QA

Отправить сообщение

Удачный шаблон документации на API, который будут читать

Уровень сложностиПростой
Время на прочтение4 мин
Количество просмотров69K

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

Вы бы стали читать рецепт из 10 страниц, чтобы приготовить салат? Что-то я сомневаюсь. Схожая ситуация бывает в документации, когда она пишется без шаблона по принципу "чем больше, тем лучше".

Если ваши  документы не читают, не понимают, или вы не знаете с чего начать описывать интеграцию,  то эта статья для вас.

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

Читать далее
Всего голосов 4: ↑4 и ↓0+4
Комментарии11

Информация

В рейтинге
Не участвует
Откуда
Москва, Москва и Московская обл., Россия
Дата рождения
Зарегистрирован
Активность

Специализация

Quality Assurance Director, Scrum Master
Lead