Size: a a a

DocOps-сообщество

2019 March 26

NV

Nick Volynkin in DocOps-сообщество
А всякие пред- и постусловия? Переходы между состояниями, если они вдруг есть?
источник

NV

Nick Volynkin in DocOps-сообщество
Fox Mulder
Да кто читает документацию))
На API обычно приходится читать. Это не GUI, интуиция не поможет
источник

FM

Fox Mulder in DocOps-сообщество
У Меня родилось страшное:
Ну вы знаете, эта документация..
источник

FM

Fox Mulder in DocOps-сообщество
Это тонко правда
источник

DB

Dima Boger in DocOps-сообщество
Nick Volynkin
А всякие пред- и постусловия? Переходы между состояниями, если они вдруг есть?
Если оно есть — в описании поля со статусами
источник

DB

Dima Boger in DocOps-сообщество
Я стараюсь сохранять минимальное расстояние между документацией и куском логики, за который она отвечает
источник

DB

Dima Boger in DocOps-сообщество
Чтобы иметь минимальные шансы что-нибудь забыть поменять
источник

AP

Anna P in DocOps-сообщество
Dima Boger
"Возвращает все магазины в округе". Остальную логику — через описание полей, фильтров, моделей...
ну а вот если, например, появилось новое поле или у старого логика поменялась. получается, описание вы не обновите?
источник

DB

Dima Boger in DocOps-сообщество
Anna P
ну а вот если, например, появилось новое поле или у старого логика поменялась. получается, описание вы не обновите?
Описание — "Возвращает все магазины в округе". Если я добавлю новое поле — оно автоматически появится в сваггере
источник

AP

Anna P in DocOps-сообщество
И непонятно будет, что оно и зачем :)
источник

DB

Dima Boger in DocOps-сообщество
Почему?
источник

DB

Dima Boger in DocOps-сообщество
Эта штука регулируется на уровне линтеров — у нового поля обязательно должно быть описание
источник

DB

Dima Boger in DocOps-сообщество
источник

DB

Dima Boger in DocOps-сообщество
свой код не покажу, а чужой — пожалуйста
источник

ДС

Денис Старков in DocOps-сообщество
Fox Mulder
Я даже в личный кабинет заходил
в личном кабинете есть запись о мероприятии, id и "Вы зарегистрированы"
источник

FM

Fox Mulder in DocOps-сообщество
Аналогично, но означает ли это доступ к конференции или это просто регистрация в кабинете
источник

ДС

Денис Старков in DocOps-сообщество
выглядит так, думаю, речь о мероприятии, а не регистрации в лк
источник

FM

Fox Mulder in DocOps-сообщество
Ага, все так же
источник

FM

Fox Mulder in DocOps-сообщество
Вот надо было так: сяпки) вы зареганы на проконтент. Ждём вас 4 апреля. Интересные доклады, снеки и шампанское вдова клико ждут вас.
источник

ДС

Денис Старков in DocOps-сообщество
Нет у них такого техписателя, как вы, поэтому все так кратко и про вдову клико никто не пишет
источник