Size: a a a

technicalwriters

2020 June 29

MS

Maria Shabanova in technicalwriters
Тоже иногда таблицы без границ использую)
источник

R

Roht in technicalwriters
Всем привет.
Ищем wysiwyg редактор для исходников (HTML), желательно десктопный и бесплатный. В какую сторону посоветуете посмотреть?
источник

ME

Maria Ermakovich in technicalwriters
Roht
Всем привет.
Ищем wysiwyg редактор для исходников (HTML), желательно десктопный и бесплатный. В какую сторону посоветуете посмотреть?
а html preview плагины в любом адвансед текстовом редакторе не подходят?
источник

ME

Maria Ermakovich in technicalwriters
потому что wysiwg и исходник в одном предложении это немножко оксюморон)
источник

R

Roht in technicalwriters
Maria Ermakovich
а html preview плагины в любом адвансед текстовом редакторе не подходят?
Надо, чтобы редактирование происходило именно в wysiwyg-формате, но тегами не мусорило
источник

R

Roht in technicalwriters
Скажем, в мадкапе так можно, но он большой и дорогой
источник

S

Sirius in technicalwriters
всем привет, можно спросить совета, особенно кто любит критиковать - понравиться)
я хожу вокруг да около этой документации (она просто очень необычная по дизайну по сравнеию с тем что раньше всегда было четко
название метода, ссылка запроса, параметры запроса, пример запроса. конец

то тут параметры post запроса прячутся в схему, которую не видно сразу, как-то городить туда текст кажется некрасивым и еще нужно добраться через все >> раскрыв https://monosnap.com/file/HQZtcFNmEAUoWGNNZzl1kfc0UqypGA

выглядит ли оно законченным?
местоположение всех элементов никто менять не будет( но цвет немного другой будет разве что
источник

S

Sirius in technicalwriters
и где лучше собственно описывать сам метод -  кратко зачем он и что получишь - сразу под названием метода или сюда, где успешный ответ?
https://monosnap.com/file/WnhQkyGKk5O8yevUxjJWIWuzUGBCVM
описывать ли каждый параметр ответа если они собственно говоря вроде бы и так понятны и перечислены
источник

NV

Nick Volynkin in technicalwriters
Sirius
всем привет, можно спросить совета, особенно кто любит критиковать - понравиться)
я хожу вокруг да около этой документации (она просто очень необычная по дизайну по сравнеию с тем что раньше всегда было четко
название метода, ссылка запроса, параметры запроса, пример запроса. конец

то тут параметры post запроса прячутся в схему, которую не видно сразу, как-то городить туда текст кажется некрасивым и еще нужно добраться через все >> раскрыв https://monosnap.com/file/HQZtcFNmEAUoWGNNZzl1kfc0UqypGA

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

L

Lana in technicalwriters
Sirius
всем привет, можно спросить совета, особенно кто любит критиковать - понравиться)
я хожу вокруг да около этой документации (она просто очень необычная по дизайну по сравнеию с тем что раньше всегда было четко
название метода, ссылка запроса, параметры запроса, пример запроса. конец

то тут параметры post запроса прячутся в схему, которую не видно сразу, как-то городить туда текст кажется некрасивым и еще нужно добраться через все >> раскрыв https://monosnap.com/file/HQZtcFNmEAUoWGNNZzl1kfc0UqypGA

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

L

Lana in technicalwriters
источник

L

Lana in technicalwriters
вы даже туда можете грузануть ваш жсон и посмотреть на ваших методах https://petstore.swagger.io/
источник

L

Lana in technicalwriters
А если все же хочется показыват развернутые параметры запроса, то вот редок например показывает в центральной колонке развернутыми их https://redocly.github.io/redoc/
источник

S

Sirius in technicalwriters
Nick Volynkin
это ж сваггер, разработчики наверняка не в первый раз увидят такой интерфейс, так что им будет понятно, куда тыкать
надеюсь, разработчики бывают разные, бывают обращаются спросить как отправить апи запрос :)

то в целом там хватит описания?
источник

DB

Dima Boger in technicalwriters
Lana
А если все же хочется показыват развернутые параметры запроса, то вот редок например показывает в центральной колонке развернутыми их https://redocly.github.io/redoc/
+ к редоку, если нужна "читабельная" документация
источник

S

Sirius in technicalwriters
Lana
вы даже туда можете грузануть ваш жсон и посмотреть на ваших методах https://petstore.swagger.io/
та я знаю как пишется этот документ, с свагер документацией ознакамливались

просто оно такое все.. непривычное.
и нет указаний особо, затык только в этих двух местах:

- подробнее описание что получишь - сразу под названием метода или в ответе (та где 200 код)
- параметры ответа обязательно расписывают или нет?
странно просто читается
name - имя контакта, и тому прочее - кто хоть немного англ знает вроде бы должен же понять))
источник

L

Lana in technicalwriters
Sirius
та я знаю как пишется этот документ, с свагер документацией ознакамливались

просто оно такое все.. непривычное.
и нет указаний особо, затык только в этих двух местах:

- подробнее описание что получишь - сразу под названием метода или в ответе (та где 200 код)
- параметры ответа обязательно расписывают или нет?
странно просто читается
name - имя контакта, и тому прочее - кто хоть немного англ знает вроде бы должен же понять))
кому непривычное-то? примерно 90 процентов девелоперов точно видели сваггер хоть раз в жизни, на основании чего сделан вывод о непривычности такого расположения?
источник

L

Lana in technicalwriters
кстати, если описанием метода планируется повторить просто его имя без новых подробностей о том, зачем это использовать, то конечно его можно опустить)
источник

L

Lana in technicalwriters
лучше уж договориться с разработчиками и проверить человекопонятность имен методов и ручек
источник

S

Sirius in technicalwriters
Lana
лучше уж договориться с разработчиками и проверить человекопонятность имен методов и ручек
им все понятно и без тех надписей что добавили)
где то на третий раз и мне стало понятно без лишних слов что к чему

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