L
Я смог, что-то с путями в конфиге проглядел, теперь все с полпинка заработало =3
Поздравляю! :)
Ребят, а кто-то как-то трекает насколько полно документация покрывает функциональность?
Какие вообще осязаемые метки используете?
Size: a a a
2019 February 26
2019 February 27
T
а по факту оно как у кого происходит?
T
у меня пока из того, что видел - что-то между “никак” и “взять доку и глазами (тестировщика) посмотреть”
T
и речь про какую документацию?
A
В esdoc и typedoc тоже есть doc coverage, если бы все было так просто, я бы не спрашивал.
Наверное стоит уточнить вопрос - функциональность имеется ввиду не та, что по коду, а живая. Все, что по коду, относится только к API, там за этим сваггер следит.
А вот как понять, например, если в команде не было какое-то время писателя (документация отстала немного), какая функциональность есть в доках, а какой нет
Наверное стоит уточнить вопрос - функциональность имеется ввиду не та, что по коду, а живая. Все, что по коду, относится только к API, там за этим сваггер следит.
А вот как понять, например, если в команде не было какое-то время писателя (документация отстала немного), какая функциональность есть в доках, а какой нет
A
Речь идёт о пользовательской документации. Все, что докается через комменты, трекается любым coverage plugin.
Мне в голову кроме как ручного подхода с использованием каких-нибудь mind maps ничего пока не идёт
Мне в голову кроме как ручного подхода с использованием каких-нибудь mind maps ничего пока не идёт
T
чеклисты ещё можно, чтобы по важному не продолбаться
T
но это всё про ручное, что может и не очень плохо
T
в Акроние прокатывали перед релизами на десятки языков, всё вручную + тесткейсы, немного было автоматизации про снятие скриншотов - но это давно, лет 10 назад
A
Сейчас вот тоже про тест кейсы подумал.
Судя по всему, нам придется комбинировать, так как есть такое, что не охватывается тест кейсами. Например, мануалы по первичной интеграции
Судя по всему, нам придется комбинировать, так как есть такое, что не охватывается тест кейсами. Например, мануалы по первичной интеграции
KC
Речь идёт о пользовательской документации. Все, что докается через комменты, трекается любым coverage plugin.
Мне в голову кроме как ручного подхода с использованием каких-нибудь mind maps ничего пока не идёт
Мне в голову кроме как ручного подхода с использованием каких-нибудь mind maps ничего пока не идёт
в трекере задач создаете на одну задачу разработчика - одну техписа (и бек и фронт не упустите), очень удобно. В зависимости от трекера накастомить можно под себя
A
в трекере задач создаете на одну задачу разработчика - одну техписа (и бек и фронт не упустите), очень удобно. В зависимости от трекера накастомить можно под себя
Да, мы так и делаем, тут без вопросов. Задача в построении некой карты, которая бы показывала незадокументированные места, если таковые есть. Потенциально, было бы здорово использовать тот же похож на проекте, где не было писателя, чтобы показать, как было до и как стало
2019 February 28
M
Жирный твиттер-тред, где программисты щеголяют ASCII-документацией
twitter.com/johnregehr/status/1095018518737637376
twitter.com/johnregehr/status/1095018518737637376
НН
Тут пролетало вроде как
НН
Интернет 9000 как всегда отстает на пару неделек по новостям, потому и отписалci
M
Я сначала на это в твиттере наткнулся, потом потерял ссылку
M
Видимо я слоупочнее чем интернет 9000 😂
НН
Штука прек конечно, хочется какое-то ascii to svg сразу натравить на такие доки