#подготовка_технической_документации — Public Fediverse posts

OpenAPI на практике: пошаговое руководство

OpenAPI — это открытая спецификация для описания REST API. Изначально она называлась Swagger, но в 2016 году была переименована в OpenAPI Specification и передана под управление OpenAPI Initiative. На данный момент Swagger — это набор инструментов для работы со спецификацией OpenAPI (Swagger UI, Editor, Codegen). В OpenAPI определяются пути, параметры, тела запросов и ответов, коды статусов, схемы данных, типы аутентификации. В статье мы рассмотрим спецификацию OpenAPI версии 3.0: разберем из каких обязательных блоков она состоит и как правильно описывать типы данных и параметры запросов.

https://habr.com/ru/companies/first/articles/973186/

#документация #open_api #проектирование_api #подготовка_технической_документации #документирование_api

OpenAPI на практике: пошаговое руководство

OpenAPI — это открытая спецификация для описания REST API. Изначально она называлась Swagger, но в 2016 году была переименована в OpenAPI Specification и передана под управление OpenAPI Initiative. На данный момент Swagger — это набор инструментов для работы со спецификацией OpenAPI (Swagger UI, Editor, Codegen). В OpenAPI определяются пути, параметры, тела запросов и ответов, коды статусов, схемы данных, типы аутентификации. В статье мы рассмотрим спецификацию OpenAPI версии 3.0: разберем из каких обязательных блоков она состоит и как правильно описывать типы данных и параметры запросов.

https://habr.com/ru/companies/first/articles/973186/

#документация #open_api #проектирование_api #подготовка_технической_документации #документирование_api

OpenAPI на практике: пошаговое руководство

OpenAPI — это открытая спецификация для описания REST API. Изначально она называлась Swagger, но в 2016 году была переименована в OpenAPI Specification и передана под управление OpenAPI Initiative. На данный момент Swagger — это набор инструментов для работы со спецификацией OpenAPI (Swagger UI, Editor, Codegen). В OpenAPI определяются пути, параметры, тела запросов и ответов, коды статусов, схемы данных, типы аутентификации. В статье мы рассмотрим спецификацию OpenAPI версии 3.0: разберем из каких обязательных блоков она состоит и как правильно описывать типы данных и параметры запросов.

https://habr.com/ru/companies/first/articles/973186/

#документация #open_api #проектирование_api #подготовка_технической_документации #документирование_api

OpenAPI на практике: пошаговое руководство

OpenAPI — это открытая спецификация для описания REST API. Изначально она называлась Swagger, но в 2016 году была переименована в OpenAPI Specification и передана под управление OpenAPI Initiative. На данный момент Swagger — это набор инструментов для работы со спецификацией OpenAPI (Swagger UI, Editor, Codegen). В OpenAPI определяются пути, параметры, тела запросов и ответов, коды статусов, схемы данных, типы аутентификации. В статье мы рассмотрим спецификацию OpenAPI версии 3.0: разберем из каких обязательных блоков она состоит и как правильно описывать типы данных и параметры запросов.

https://habr.com/ru/companies/first/articles/973186/

#документация #open_api #проектирование_api #подготовка_технической_документации #документирование_api

Правки, конфликты, редактура… релиз! Один рабочий день технического писателя Феди в IT-компании

Утренний кофе выпит, бутерброд съеден, довольные коты накормлены. Федя сразу включается в работу — дел много, нужно всё успеть. Но для начала нужно обновить локальные исходники разделов из репозитория. Это не первый его релиз. И Фёдор уже привычно запускает синхронизацию... Напряжение ощущается с самого утра — в рабочем чате постоянно всплывают сообщения: «Забираю исходник раздела с описанием общего алгоритма — буду вносить правки», «Добавил в карту документа пару новых приложений, обновитесь», «Перешлите мне комментарии тестировщика — у меня письмо затерялось». Сегодня не просто очередной рабочий день, сегодня день релиза .

https://habr.com/ru/companies/bercut/articles/952952/

#технический_писатель #документация #релиз #техническая_документация #редактор #работа_в_команде #подготовка_технической_документации #пользовательская_документация #рабочий_день_в_ит #bercut

Правки, конфликты, редактура… релиз! Один рабочий день технического писателя Феди в IT-компании

Утренний кофе выпит, бутерброд съеден, довольные коты накормлены. Федя сразу включается в работу — дел много, нужно всё успеть. Но для начала нужно обновить локальные исходники разделов из репозитория. Это не первый его релиз. И Фёдор уже привычно запускает синхронизацию... Напряжение ощущается с самого утра — в рабочем чате постоянно всплывают сообщения: «Забираю исходник раздела с описанием общего алгоритма — буду вносить правки», «Добавил в карту документа пару новых приложений, обновитесь», «Перешлите мне комментарии тестировщика — у меня письмо затерялось». Сегодня не просто очередной рабочий день, сегодня день релиза .

https://habr.com/ru/companies/bercut/articles/952952/

#технический_писатель #документация #релиз #техническая_документация #редактор #работа_в_команде #подготовка_технической_документации #пользовательская_документация #рабочий_день_в_ит #bercut

Правки, конфликты, редактура… релиз! Один рабочий день технического писателя Феди в IT-компании

Утренний кофе выпит, бутерброд съеден, довольные коты накормлены. Федя сразу включается в работу — дел много, нужно всё успеть. Но для начала нужно обновить локальные исходники разделов из репозитория. Это не первый его релиз. И Фёдор уже привычно запускает синхронизацию... Напряжение ощущается с самого утра — в рабочем чате постоянно всплывают сообщения: «Забираю исходник раздела с описанием общего алгоритма — буду вносить правки», «Добавил в карту документа пару новых приложений, обновитесь», «Перешлите мне комментарии тестировщика — у меня письмо затерялось». Сегодня не просто очередной рабочий день, сегодня день релиза .

https://habr.com/ru/companies/bercut/articles/952952/

#технический_писатель #документация #релиз #техническая_документация #редактор #работа_в_команде #подготовка_технической_документации #пользовательская_документация #рабочий_день_в_ит #bercut

Правки, конфликты, редактура… релиз! Один рабочий день технического писателя Феди в IT-компании

Утренний кофе выпит, бутерброд съеден, довольные коты накормлены. Федя сразу включается в работу — дел много, нужно всё успеть. Но для начала нужно обновить локальные исходники разделов из репозитория. Это не первый его релиз. И Фёдор уже привычно запускает синхронизацию... Напряжение ощущается с самого утра — в рабочем чате постоянно всплывают сообщения: «Забираю исходник раздела с описанием общего алгоритма — буду вносить правки», «Добавил в карту документа пару новых приложений, обновитесь», «Перешлите мне комментарии тестировщика — у меня письмо затерялось». Сегодня не просто очередной рабочий день, сегодня день релиза .

https://habr.com/ru/companies/bercut/articles/952952/

#технический_писатель #документация #релиз #техническая_документация #редактор #работа_в_команде #подготовка_технической_документации #пользовательская_документация #рабочий_день_в_ит #bercut

Документация по-взрослому: GWT для реальных проектов глазами системного аналитика

Есть два типа системных аналитиков: те, кто на слова "Acceptance Criteria" кивают уверенно, и те, кто кивают с лицом человека, которому эти слова не приносит радости. А потом открываешь их спецификацию и понимаешь, что критерии приёмки там формулировал кто угодно, но только не человек, который собирается это реализовывать. Если ты читал мою прошлую статью на Хабре про Gherkin , то уже знаешь, что синтаксис GWT - это не просто красивый способ писать тесты. Это способ фиксировать поведение системы в формате , который понятен и бизнесу, и тестированию и разработчику.

https://habr.com/ru/articles/906740/

#системный_аналитик #системный_анализ #проектная_документация #работа_с_требованиями #требования_к_системе #подготовка_технической_документации #управление_продуктом

Документация по-взрослому: GWT для реальных проектов глазами системного аналитика

Есть два типа системных аналитиков: те, кто на слова "Acceptance Criteria" кивают уверенно, и те, кто кивают с лицом человека, которому эти слова не приносит радости. А потом открываешь их спецификацию и понимаешь, что критерии приёмки там формулировал кто угодно, но только не человек, который собирается это реализовывать. Если ты читал мою прошлую статью на Хабре про Gherkin , то уже знаешь, что синтаксис GWT - это не просто красивый способ писать тесты. Это способ фиксировать поведение системы в формате , который понятен и бизнесу, и тестированию и разработчику.

https://habr.com/ru/articles/906740/

#системный_аналитик #системный_анализ #проектная_документация #работа_с_требованиями #требования_к_системе #подготовка_технической_документации #управление_продуктом

Документация по-взрослому: GWT для реальных проектов глазами системного аналитика

Есть два типа системных аналитиков: те, кто на слова "Acceptance Criteria" кивают уверенно, и те, кто кивают с лицом человека, которому эти слова не приносит радости. А потом открываешь их спецификацию и понимаешь, что критерии приёмки там формулировал кто угодно, но только не человек, который собирается это реализовывать. Если ты читал мою прошлую статью на Хабре про Gherkin , то уже знаешь, что синтаксис GWT - это не просто красивый способ писать тесты. Это способ фиксировать поведение системы в формате , который понятен и бизнесу, и тестированию и разработчику.

https://habr.com/ru/articles/906740/

#системный_аналитик #системный_анализ #проектная_документация #работа_с_требованиями #требования_к_системе #подготовка_технической_документации #управление_продуктом

Документация по-взрослому: GWT для реальных проектов глазами системного аналитика

Есть два типа системных аналитиков: те, кто на слова "Acceptance Criteria" кивают уверенно, и те, кто кивают с лицом человека, которому эти слова не приносит радости. А потом открываешь их спецификацию и понимаешь, что критерии приёмки там формулировал кто угодно, но только не человек, который собирается это реализовывать. Если ты читал мою прошлую статью на Хабре про Gherkin , то уже знаешь, что синтаксис GWT - это не просто красивый способ писать тесты. Это способ фиксировать поведение системы в формате , который понятен и бизнесу, и тестированию и разработчику.

https://habr.com/ru/articles/906740/

#системный_аналитик #системный_анализ #проектная_документация #работа_с_требованиями #требования_к_системе #подготовка_технической_документации #управление_продуктом

Как ошибка в ТЗ сделала из тигра бобра, или Почему дизайн — пиковый туз в колоде цифрового продукта

Всем привет! Я Вика Левена, руководитель отдела аналитики в AGIMA . По роду деятельности я много работаю с дизайнерами. На рынке заказной разработки (да и не только) все точно понимают, насколько важна роль дизайна. Но когда приходит время доказать эту важность , ситуация превращается в ту самую сороконожку, которая не знает с какой ноги она начала идти. Поэтому (а еще потому что я аналитик) в этой статье я решила систематизировать пользу, которую приносит дизайн. Здесь я постаралась разложить всё по полочкам, привести примеры и цифры — как говорится, «на случай важных переговоров».

https://habr.com/ru/companies/agima/articles/854428/

#дизайн #техническое_задание #подготовка_технической_документации #стратегия #продуктовый_дизайн #продуктовая_стратегия #ux #uxисследования #глубинные_интервью