нуу, интерактивное апи не все используют, не приходилось раньше сталкиваться, вот и непривычно.

просмотрела, действительно выглядит как стандартная схема свагера, только решили добавить свои css стили (на другом скрине моем они)

Через редок как-то все яснее выложено, читаю документацию, кажется что файлы для сварега и редок одни и те же? нет определенного нового синтаксиса для того опенапи?
простите за глупые вопросы если так кажется) думаю с какой стороны начать, и стоит ли предлагать его лучше догрузить, чем просто стили

не нравится что в той версии что сейчас сделали - не будет навигационного меню слева по методам, как есть в редоке и было у нас с обычной html версткой

да, openapi json один тот же

насколько я помню, внутри json можно писать маркдауном во вложенных элементах даже, синтаксис openapi json довольно строго определен, но в нем множество возможностей - ref, множественные примеры

#wanted_tw #СПБ #Петербург https://just-ai.com/

Вcем привет!
Ищем в команду Just AI Junior Technical Writer

Надо будет:

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

Любим и уважаем docs as code!

Полное описание вакансии: https://spb.hh.ru/vacancy/37706842

Откликов ждёт Аня: @Slavnayaanya

а сколько примерно по времени запрашивали бы - которое нужно на написание документации (40 методов)

При том что основная структура по этой разметке уже написана

Осталось только добавить (подставить текст) название метода, общее описание метода и описание параметров
Большинство параметров повторяются, уникальных значений где-то 12

вот сюда (это php файл, но разметка та же) https://monosnap.com/file/LhE34grPpeuEvkGLgNoYoqdmkBC27c

и я так понимаю, что ответы не описываются,
если 200 - то просто "Операция успешна", без всяких если успешна, то получите ....

ответы описываются как раз внутри массива responses, там можно указывать не только описание(кстати на скрине не самый удачный пример описания, я бы лучше в описание писала, что отдается в случае успеха или например что-то вроде объект создан), а content, схемки ответов, объекты типа $ref (это такой элемент, который можно один раз прописать и его потом использовать в неск местах). ничего кроме описания не пишется только если ничего не возвращается собственно

Хм 🤔 но в таком случае описание ответа (какие данные получаем) дублирует описание метода - возвращаясь к изначальному вопросу)

это будто нужно выбирать или тут писать или там. а то масло масленное

Хотела посмотреть как те же методы у конкурента описаны - прям вообще топчик 🙈 вообще ничего не описано https://api.manychat.com/swagger#/Page/post_fb_page_createTag
не заморачиваются ни описанием, ни дизайном

Вместе с группой переводчиков-волонтеров мы запустили сайт stopcovid19.com.ru. Он создан, чтобы обеспечить российских медиков, которые борются с Ковид, актуальной информацией из зарубежных источников. Если у вас есть знакомые медики, поделитесь, пожалуйста, с ними ссылкой на этот сайт. Спасибо.

А давайте обсудим разные направления для роста и диверсификации навыков технического писателя. Что ещё полезного стоит освоить техническому писателю, чтобы повысить свою ценность и остаться на плаву, если вдруг уютную лодку стабильного трудоустройства накроет очередным непредвиденным штормом?

вы имеете ввиду направления для роста именно в условиях штормов?

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

Имхо, рано это угадывать.
Пока рынок перекосился к тому, что спрос в сторону писателей вырос активнее других профессий.

Какой будет следующий перекос - неясно

а чем это отличается от обычного развития техписа? языки, аналитика и т.п.

вы же не про навыки вязать узлы и добывать питьевую воду, я думаю)

Я вот на курсы девопсов в нетологии записался. И чтоб уметь все эти докеры с кубернетсами описывать, а я думаю все чаще такие задачи будут и может потом в эту сторону свернуть. Ну и для докопса знать девопс в целом нелишне будет

Для себя я наметил такой путь саморазвития на ближайшее время - HTML - CSS - JavaScript - Node.js- SQL - PHP - Ruby on Rails - Python - Java. Пока что обучаюсь при помощи онлайн-тренингов на сайте LinkedIn Learning и прикупил немного курсов на Udemy.

+1, отличный флоу, иду похожим путём, но немного по другой дороге (на freecodecamp)

После этого, можно будет добавить в программу самообучения и разные Kubernetes, Docker, Azure, Amazon AWS.