Size: a a a

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

2019 January 25

A

Antonio in DocOps-сообщество
Мы не выкатываем доки, пока не убедимся, что описаны основные моменты ее работы и настройки. Потому, как если целевая аудитория не до конца понимает, как пользоваться фичей, то это недоработка писателя. После релиза доки, мы обычно дописываем только какие-то corner cases, но, функциональность фичи всегда должна быть подробно описана
источник
2019 January 26

ML

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

ML

Maksim Lapshin in DocOps-сообщество
это отличается от ТЗ, потому что ТЗ нужен для того, что бы формализовать _что прогать_, а дока описывает, как поменяется жизнь юзера после этой фичи
источник

ML

Maksim Lapshin in DocOps-сообщество
внезапно это помогает не делать фигни
источник

SB

Sergey Bronnikov in DocOps-сообщество
Maksim Lapshin
внезапно это помогает не делать фигни
А много времени на такое занятие уходит у разработчиков? И не проще ли помимо ТЗ писать стори/сценарии использования и убеждаться разработчик с ними ознакомился?
источник

ML

Maksim Lapshin in DocOps-сообщество
Sergey Bronnikov
А много времени на такое занятие уходит у разработчиков? И не проще ли помимо ТЗ писать стори/сценарии использования и убеждаться разработчик с ними ознакомился?
мы ТЗ вообще не пишем, у нас нет такой практики
источник

ML

Maksim Lapshin in DocOps-сообщество
времени уходит не очень много, но если много, то значит что задача сложная и всё равно такое надо делать. Т.е. если программист не знает, как потом пользоваться фичей, то как он её вообще может сделать =)
источник

ML

Maksim Lapshin in DocOps-сообщество
Понятно, что это касается тех, кто делает документируемые фичи. Дата сатанисты, которые пилят нейросетки от этого отстоят на два шага, но им нужно другое понимать: как это в принципе будет работать, так что их тоже беспокоит финальная документация
источник

SB

Sergey Bronnikov in DocOps-сообщество
А в какой форме происходит общение между заказчиками или сейлзам? Какая то постановка задачи для разработки должна же быть.
источник

SB

Sergey Bronnikov in DocOps-сообщество
Maksim Lapshin
времени уходит не очень много, но если много, то значит что задача сложная и всё равно такое надо делать. Т.е. если программист не знает, как потом пользоваться фичей, то как он её вообще может сделать =)
Согласен. Но на практике так делают и потом им фичу обратно  возвращают, потому что сделали не то что надо было.
источник

ML

Maksim Lapshin in DocOps-сообщество
Мы сами делаем свой продукт и стараемся не заниматься какой-либо существенной доработкой под кастомеров. Поддержка — да, но только в виде того кода, который потом много кому ещё пригодится
источник

NV

Nick Volynkin in DocOps-сообщество
Maksim Lapshin
Я сейчас начал пытаться потихоньку внедрять doc first подход, когда прежде чем взяться за кодирование, программист с техписом пишут будущую документацию на сайт
Звучит как отличная тема на knowledgeconf.ru! Результаты уже есть или подождем до 2020? :)
источник

НН

Нац Нац in DocOps-сообщество
Sergey Bronnikov
А много времени на такое занятие уходит у разработчиков? И не проще ли помимо ТЗ писать стори/сценарии использования и убеждаться разработчик с ними ознакомился?
О у меня был где-то перевод про document driven development, если надо
источник

НН

Нац Нац in DocOps-сообщество
Сорри, что так редко выходит какой-то ориджынал контент, совсем нет времени, но вот вам (довольно небрежный, если уж совсем на чистоту, но суть ясна) мой перевод статьи Тома Престона-Вернера, со-основателя GitHub, о важности написания README в самом начале разработки (чего-либо).

https://telegra.ph/Readme-Driven-Development-09-25
источник

EN

Ekaterina Noskova in DocOps-сообщество
Нац Нац
О у меня был где-то перевод про document driven development, если надо
А поделитесь
источник

НН

Нац Нац in DocOps-сообщество
Ekaterina Noskova
А поделитесь
Выше
источник

EN

Ekaterina Noskova in DocOps-сообщество
Так это про readme driven development, а не про documentation driven development. Это же не одно и то же?
источник

ML

Maksim Lapshin in DocOps-сообщество
Nick Volynkin
Звучит как отличная тема на knowledgeconf.ru! Результаты уже есть или подождем до 2020? :)
Немного есть результаты
источник

EN

Ekaterina Noskova in DocOps-сообщество
источник

НН

Нац Нац in DocOps-сообщество
Ekaterina Noskova
Так это про readme driven development, а не про documentation driven development. Это же не одно и то же?
Я попутал, но суть, казалось, та же
источник