В рейтинге участвует:

групп:

каналов:

Виртуальный сервер на SSD - недорого!

Аренда выделенных и виртуальных серверов (VDS/VPS), хостинг, аренда IP-адресов, администрирование, круглосуточная поддержка

qwarta.ru подробнее

Резервное копирование с проверкой на вирусы!!!

Удобный сервис создания резервных копий на любой сервер сети интернет. Отслеживайте изменения, проверяйте на вирусы. Надежно защитите свой бизнес!

go.backupland.com

Выбираете сервер? Любая конфигурация на заказ!

Аренда физических серверов любых конфигураций под любые запросы - 1С бухгалтерия, игровые сервера, нагруженные проекты, интернет-магазины!

qwarta.ru подробнее

Size: a a a

technicalwriters

1059 membersпожаловаться на группу
2020 May 15

N

Noname in technicalwriters
Kateryna Ushakova
Лучше это тоже уточнить у заказчика) если считаете важным — описывайте, конечно. Тем более если нет четкого списка что должно быть в конечном документе — вся информация на ваше усмотрение. Но когда сомневаетесь — лучше уточнить у заказчика.
Я если честно,пока не готова уточнять у Заказчика,поскольку не знакома с API на все 100%.Мне бы очень хотелось вы спросить,как действующие,более опытные ТП пишут документацию,как описывают конечные точки
источник
23:51пожаловаться#1

N

Noname in technicalwriters
У меня сейчас в голове полная каша плюс одни сомнения.Пришла сюда за поддержкой,советами)
источник
23:52пожаловаться#2

KU

Kateryna Ushakova in technicalwriters
Noname
Я если честно,пока не готова уточнять у Заказчика,поскольку не знакома с API на все 100%.Мне бы очень хотелось вы спросить,как действующие,более опытные ТП пишут документацию,как описывают конечные точки
Посмотрите примеры. Документацию stripe, yandex, telegram, например) посмотрите что вам нравится и что подходит под информацию, которая у вас уже есть.
источник
23:53пожаловаться#3

N

Noname in technicalwriters
Kateryna Ushakova
Посмотрите примеры. Документацию stripe, yandex, telegram, например) посмотрите что вам нравится и что подходит под информацию, которая у вас уже есть.
Спасибо!
источник
23:53пожаловаться#4
2020 May 16

FM

Fox Mulder in technicalwriters
А вы уверены, что сможете описать API не будучи знакомы с кодом?
источник
00:01пожаловаться#5

N

Noname in technicalwriters
Fox Mulder
А вы уверены, что сможете описать API не будучи знакомы с кодом?
Нет,не уверена.
источник
00:10пожаловаться#6

N

Noname in technicalwriters
Я сейчас не отвечу с 💯 ни на один вопрос касательно документированич API
источник
00:11пожаловаться#7

N

Noname in technicalwriters
Все ,что есть в наличии в меня:природная любознательность,опыт работы классическим БА,небольшие знания БД,спека от Заказчика и огромное желание.
источник
00:12пожаловаться#8

N

Noname in technicalwriters
Noname
Все ,что есть в наличии в меня:природная любознательность,опыт работы классическим БА,небольшие знания БД,спека от Заказчика и огромное желание.
И я надеюсь,что смогу выдать хотя бы требования для описания конечной точки.Но не код.
источник
00:13пожаловаться#9

FM

Fox Mulder in technicalwriters
почитайте
источник
00:19пожаловаться#10

FM

Fox Mulder in technicalwriters
https://starkovden.github.io/Doc-as-code-tools.html
Инструменты подхода Docs-as-code | learnapidoc-ru
Курс по документированию API. Вольный перевод курса https://idratherbewriting.com/learnapidoc/
источник
00:20пожаловаться#11

N

Noname in technicalwriters
Fox Mulder
https://starkovden.github.io/Doc-as-code-tools.html
Инструменты подхода Docs-as-code | learnapidoc-ru
Курс по документированию API. Вольный перевод курса https://idratherbewriting.com/learnapidoc/
Спасибо,я его очень активно изучаю.Но ещё много пробелов у меня лично,чтобы понять весь курс
источник
00:21пожаловаться#12

N

Noname in technicalwriters
Noname
Спасибо,я его очень активно изучаю.Но ещё много пробелов у меня лично,чтобы понять весь курс
Кстати,не в тему:но мне нравится ваш ник).Истина где то рядом)
источник
00:21пожаловаться#13

FM

Fox Mulder in technicalwriters
Noname
Кстати,не в тему:но мне нравится ваш ник).Истина где то рядом)
спасибо
источник
01:03пожаловаться#14

IC

Ivan Cheban in technicalwriters
Noname А можно вопрос? Как получилось, что вы из БА в техрайтеры? Обычно наоборот. Или вы продолжаете работать БА, просто дополнительно нужно выполнять задачи техрайтера?
источник
08:29пожаловаться#15

A

Andrey in technicalwriters
Fox Mulder
А вы уверены, что сможете описать API не будучи знакомы с кодом?
Вы имеете ввиду что техписатель будет писать API, которое написано до него и никем не поддерживается?

Обычно же есть программист, который дает нужную информацию.
источник
10:05пожаловаться#16

FM

Fox Mulder in technicalwriters
Andrey
Вы имеете ввиду что техписатель будет писать API, которое написано до него и никем не поддерживается?

Обычно же есть программист, который дает нужную информацию.
Возьмём JetBrains, для примера. Техписы в этой компании есть сплав мидла и техписа.
Вопрос лишь в том, какими ресурсами обладает команда проекта, могут ли они позволить стабильное разделение ролей.
Ну и квалификация команды тоже играет существенную роль. Если часто дёргать кодера по вопросам, то тебя, как техписа, уволят за профнепригодность.
Поэтому, имхо, если ты сидишь в проекте, где надо вплотную работать с кодом, в том числе и с API, то ты обязан разбираться в коде на уровне джуна минимум.
И REST API - это не самое сложное для понимания.
Куда сложнее, если ваш проект на java и вам надо в java.
Я тут недавно собирал jar-пакет с нуля - лучше бы написал ГОСТ-докУмент )
источник
10:11пожаловаться#17

A

Andrey in technicalwriters
Fox Mulder
Возьмём JetBrains, для примера. Техписы в этой компании есть сплав мидла и техписа.
Вопрос лишь в том, какими ресурсами обладает команда проекта, могут ли они позволить стабильное разделение ролей.
Ну и квалификация команды тоже играет существенную роль. Если часто дёргать кодера по вопросам, то тебя, как техписа, уволят за профнепригодность.
Поэтому, имхо, если ты сидишь в проекте, где надо вплотную работать с кодом, в том числе и с API, то ты обязан разбираться в коде на уровне джуна минимум.
И REST API - это не самое сложное для понимания.
Куда сложнее, если ваш проект на java и вам надо в java.
Я тут недавно собирал jar-пакет с нуля - лучше бы написал ГОСТ-докУмент )
Ясно. Это хард. Я с таким на радость не сталкивался😁
источник
10:14пожаловаться#18

FM

Fox Mulder in technicalwriters
Из моего кейса: ребята написали новые методы для API. Они были с ошибками, ребята спешили перед сдачей. Мне пришлось править. Ошибок было несколько, одна из них - совмещение спецификации 2 версии АПИ с третьей.
источник
10:15пожаловаться#19

A

Andrey in technicalwriters
А то я уже думал в техписательство из аналитики вкатиться. Но к такому меня жизнь не готовила.
источник
10:16пожаловаться#20