Документация

У меня была возможность понаблюдать как Event Storming работает на реальном проекте. Не напрямую. Всего лишь по-рассказам. Но этого приближения хватило для того, чтобы сделать несколько интересных выводов. Сейчас я с вами этим поделюсь. Предыстория Разрабатывают внутренний продукт, который должен автоматизировать сложные и запутанные процессы. Роли бизнес-аналитиков и системных отделены. Это разные специалисты. И тех, […]

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

Эта статья – попытка внедрить в свою жизнь “всё хорошее” из доклада Юрия Куприянова “Стоп слова в требованиях к ПО” (доклад может быть известен и под другими названиями). Слушать было легко и интересно. Прекрасно, что я теперь всё это знаю. Но как начать применять? Как писать Требования хорошо?  А что такое “хорошо”? Хорошие Требования – […]

Если перед вами стоит задача задокументировать API протокола JSON-RPC, воспользуйтесь этим примером как отправной точкой.

Опубликовали полностью заполненный пример и приложили шаблон документа для скачивания.

Бизнес и системные аналитики часто работают с документацией, описывающей API различных сервисов. Если их (сервисов) в компании больше двух и они обмениваются между собой данными в архитектурном стиле REST, есть смысл изучить фреймворк Swagger, также известный как OpenAPI. Основные преимущества ведения REST API документации в Swagger: Вся эта информация описывается в одном документе, но отображается […]