Size: a a a

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

2021 May 11

NP

Nikolaj Potashnikov in DocOps-сообщество
Доработал проект конвертера их Asciidoctor в Open Document. Тесты подключил и теперь PRs are welcome. И сразу статью на эту тему https://habr.com/ru/post/556624/ , конечно с плачем Ярославны, потому как работы еще очень много
источник

J

Jonny Cuba in DocOps-сообщество
Ожидать можно что угодно) это вопрос к СБ,  у меня не стоит на компьютере телеграм и более того, даже к интернету его подключать нельзя, поэтому только так
источник

RG

Ramil G in DocOps-сообщество
Я тут с советом: Сделай сайтик для тестового использования. Как мне кажется, наибольший интерес возникнет к выводу по шаблону гост 34
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Я уже у Михаила философтовские шаблоны взял, смотрю на них. С сайтом — интересная мысль. Какого рода содержание там могло бы быть? Я так понимаю — цель — помочь быстро втянуться тем, где готовит документацию по ГОСТ 34?
источник

J

Jonny Cuba in DocOps-сообщество
И по 19)
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
У Фрэнка Синатры была песенка такая Love and marriage... go together like a horse and carriage
источник

J

Jonny Cuba in DocOps-сообщество
Да да)
источник

RG

Ramil G in DocOps-сообщество
Там должно быть одно поле для загрузки файла, выпадающий список (с одним-двумя шаблонами) и кнопка
источник

RG

Ramil G in DocOps-сообщество
Каптча ещё
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
а... я понял, тогда, наверное, лучше zip грузить
источник

RG

Ramil G in DocOps-сообщество
докер это хорошо, но целевая аудитория этого конвертора - техписы.
источник

NV

Nick Volynkin in DocOps-сообщество
А где противоречие?
источник

RG

Ramil G in DocOps-сообщество
ну вот не каждый техпис захочет или сможет ради "попробовать" разворачивать. не у всех на рабочих компах стоит докер, а у девопса не допросишься
источник

NV

Nick Volynkin in DocOps-сообщество
@nmpotashnikoff а как тебе вариант с GH Actions, который собирает из исходников файлы и публикует их на GH Pages?
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
если ты посмотришь на https://github.com/CourseOrchestra/asciidoctor-open-document , он так и сделан: тестовые файлы собираются в GH Actions, и далее проверяются на соответствие схеме Open Document, если файл не создался или не соответствует схеме, PR не пройдёт.. На это было убита куча времени, особенно на поиск docker-image с LibreOffice, который нормально работает в GH Actions

а вот готовый GH Actions — это было бы здорово... Не думаю, что это сложно... интересно, а спрос есть, вообще многие собирают документацию в github?
источник

NV

Nick Volynkin in DocOps-сообщество
А, я ещё не успел посмотреть )
источник

NV

Nick Volynkin in DocOps-сообщество
Готовый подключаемый GH Action — это отличная штука. Мы используем такие в наших сборках, например https://github.com/tarantool/doc/blob/latest/.github/workflows/update-pot.yml
источник
2021 May 12

СФ

Семён Факторович... in DocOps-сообщество
Честно говоря, не вполне понял предлагаемый подход:( Если не наем новых людей, то что?

В моей практике вопрос найма новых людей вставал ровно в одном случае: когда скорость накопления документационного долга была выше, чем скорость, с которой текущая команда его тушит. Например, когда новые фичи появляются быстрее, чем мы успеваем их документировать с должным качеством.

Если ситуация такова, то (в моей практике, опять же) никакими другими способами, кроме расширения команды, ее не решить.

Начальник на предыдущей работе рисовал интересную иллюстрацию: маленькая техписательская команда в описанном выше случае, вообще говоря, со временем только ухудшает ситуацию с документацией. Со временем доля задокументированных фич в отношении к общему количеству фич становится только меньше. Если бы техписателей вообще не было, то этот процент тоже становился бы меньше (но не так быстро), но в любом случае: с точки зрения бизнеса недостаточно большая команда техписателей всегда имеет отрицательную эффективность. Более высокую, чем отсутствующая команда техписателей, но все равно отрицательную.

А вот если проблема в чем-то другом, но кто-то (только вот кто?) предлагает решать ее расширением команды — тогда да, возможны варианты. Но в целом это какая-то странная ситуация: к руководителю документационной команды приходит кто-то и заставляет его против воли нанимать новых людей:)
источник

СФ

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

ME

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