Size: a a a

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

2019 October 17

NV

Nick Volynkin in DocOps-сообщество
А почему это важно? Документ слишком большой и на глаз сопоставить сложно?
источник

NV

Nick Volynkin in DocOps-сообщество
Vadim Smelyanskiy
Такие есть, да

О чём именно я мечтаю, так это об ассоциации этих строк комментариев со строчками в исходниках (.md, .rst и т.д.)
Это был бы очень полезный плагин для Sphinx.
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Nick Volynkin
А почему это важно? Документ слишком большой и на глаз сопоставить сложно?
Нет, там даже на глаз не нужно сопоставлять, если главы пронумерованы

Процесс для тех.писа наполняется рутиной, производительность падает

1. Напиши документ в редакторе X
2. Пройдись по результату от lint'а, измени исходник в редакторе X
3. Пройдись по ревью в GitLab'е, измени исходник в редакторе Х
4. Пройдись по комментариям в Google Docs, пройди по соответствующей главе измени исходник в редакторе Х
источник

NV

Nick Volynkin in DocOps-сообщество
А как выглядел бы идеальный процесс?
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Nick Volynkin
А как выглядел бы идеальный процесс?
Как в Word

Есть WYSIWYG абзац, на нём размечены комментарии, подсвечены строки по результату проверок от Word'а, inline предложенные исправления и т.д.
источник

NV

Nick Volynkin in DocOps-сообщество
Чтобы даже предложенные исправления коммитить по кнопке?
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Лучше не коммитить, но на стейдж в рабочую копию сливать

А так да
источник

NV

Nick Volynkin in DocOps-сообщество
Ну да, это имеет смысл, если ревьюер активно предлагает правки.
источник

NV

Nick Volynkin in DocOps-сообщество
Там недавно JetBrains собирали требования к инструменту для документации на основе их IDE. Может, у них есть что-то подобное там.
источник

НН

Нац Нац in DocOps-сообщество
Текстовый редактор на джаве, что может быть интереснее
источник

СФ

Семён Факторович in DocOps-сообщество
Нац Нац
Текстовый редактор на джаве, что может быть интереснее
как будто это что-то плохое! (оглядывается на 8+ GB RAM на всех компьютерах в офисе и дома)
источник

НН

Нац Нац in DocOps-сообщество
8 это мало
источник

НН

Нац Нац in DocOps-сообщество
для жавы
источник

СФ

Семён Факторович in DocOps-сообщество
это была попытка в иронию
источник

НН

Нац Нац in DocOps-сообщество
тоненько!
источник

СФ

Семён Факторович in DocOps-сообщество
но вообще хочется надеяться, что парсить, раскрашивать и держать в памяти DOM маркдаун-документа должно быть полегче, чем миллиона строк в джава-проекте
источник

НН

Нац Нац in DocOps-сообщество
Надеюсь они чот порешают с этим однажды, чтоб не надо было кучу настраивать и вот это вот всё
источник

СФ

Семён Факторович in DocOps-сообщество
для документации же ни статического анализа не надо, ничего такого вот
источник

НН

Нац Нац in DocOps-сообщество
можно в webstorm повырубать всё и включить md плагин, сиравно буит жрать всё
источник

СФ

Семён Факторович in DocOps-сообщество
груздь-печаль
источник