Size: a a a

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

2018 August 27

DN

Dmitry Nagovitsin in DocOps-сообщество
вообще удобно
источник

VK

Vladimir Khineev in DocOps-сообщество
плюсую, тем более в последнем обновлении появился редактор
источник

RT

Roman Tsirulnikov in DocOps-сообщество
Коллеги, поделитесь опытом использования AsciiDoctor-PDF + Asciidoctor-diagram (PlantUML).
Масштабирование PlantUML диаграммы при сборке PDF.
Есть ли способ разместить крупную диаграмму на нескольких листах документа?
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Roman Tsirulnikov
Коллеги, поделитесь опытом использования AsciiDoctor-PDF + Asciidoctor-diagram (PlantUML).
Масштабирование PlantUML диаграммы при сборке PDF.
Есть ли способ разместить крупную диаграмму на нескольких листах документа?
Речь идёт о распечатке для склейки? Или это должны быть разные страницы документа?
источник

RT

Roman Tsirulnikov in DocOps-сообщество
вопрос скорее о том как правильно работать с большими диаграммами для разбивки их на множество страниц PDF документа
источник

НН

Нац Нац in DocOps-сообщество
Как их в разрыве воспринимать потом?
источник

EN

Ekaterina Noskova in DocOps-сообщество
@Nick_Volynkin как там насчет видео и презентаций с митапа?
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
В общем, если надо распечатать и склеить, то Inkscape. Если же делить, то я бы декомпозировал на несколько диаграмм.
источник

НН

Нац Нац in DocOps-сообщество
голосую за декомпозицию
источник
2018 August 28

NV

Nick Volynkin in DocOps-сообщество
Ekaterina Noskova
@Nick_Volynkin как там насчет видео и презентаций с митапа?
Я только отоспался после хакатона ))
источник

NV

Nick Volynkin in DocOps-сообщество
Сегодня постараюсь выложить презентации
источник

АГ

Андрей 🦀PAK3APYKY✋ Гаврилов in DocOps-сообщество
Плюс к декомпозиции. Если диаграмму просто рвать на куски - получится нечитаемо. Нужно выделить логические блоки.
источник

AG

Alexey Golubev in DocOps-сообщество
Господа, всем привет. Я сейчас занимаюсь разработкой стурктуры документации проектов в компании и хотел бы с вами посоветоваться.
Для себя я выделил что есть три типа документации: Проектаня документация (эстимейты, митинг ноутс, груминг задач), Продуктная документация (ака Техническая документация) и тестовая документация

Проектную документация, по моему плану, ведет  Проектный менеджер
Техническую - отдел тестирования
И возникает вопрос с продуктной документацией. Кто ее должен вести? Где ее хранить, чтобы потом было удобно отдавать клиенту?
В моей представлении время на продуктную документацию  закладывается в эстимейт и тех лид проекта перед стартом спринта определяет какие компоненты системы необходимо будет описать, а документацию пишут разработчики. Но по партизански читая ваш чатик я столкнулся с тем, что существую тех писы, и что есть разные подходы.

Передо мной стоит задача - описать процесс и роли в нем. Может кто-то поделится своим опытом по заданным вопросам.
Еще раз резюмируя:
Кто  ведет продуктную дркументацию?
Где ее хранить, чтобы потом было удобно отдавать клиенту? (md, прямо в репозитории?)
Какие роли могут быть?
источник

NV

Nick Volynkin in DocOps-сообщество
Здравствуйте! Расскажите подробней про задачу. Что вы хотите описать в дкоументации, с какой целью? Что именно вы хотите отдавать клиенту или что он хочет от вас получить?
источник

NV

Nick Volynkin in DocOps-сообщество
Вы на заказ что-то разрабатываете? Для внешнего заказчика или внутреннего?
источник

AG

Alexey Golubev in DocOps-сообщество
>Что вы хотите описать в дкоументации, с какой целью?
В продуктной документации я хочу описывать компоненты системы, классы, взаимодействия, существующие зависимости, примеры использования и общее назначение этих классов. (пример Есть фича разворачивания какой-то инфраструктуры и менеджер который этим управляет, я бы хотел описать как использовать этот менеджер, какие параметры он принимает, какие еще компоненты использует). Возможно, информацию о лицензиях этих зависимостей (если просит клиент)


>что именно вы хотите отдавать клиенту или что он хочет от вас получить?
Я хочу чтобы на финише проекта у нас была продуктная документация по всем ключевым компонентам системы, которые отвечают за основной функционал

>Для внешнего заказчика или внутреннего?
Аутсорс
источник

NV

Nick Volynkin in DocOps-сообщество
> Где ее хранить, чтобы потом было удобно отдавать клиенту? (md, прямо в репозитории?)

Md удобно редактировать и обрабатывать программно. У клиента могут быть свои представления об удобстве, а то и жесткие требования. Но PDF или Word тоже можно из Md делать.

Если клиенту удобно прямо в репозитории, мне нравится этот клиент.
источник

NV

Nick Volynkin in DocOps-сообщество
По тому что описывать: я бы поговорил с клиентом о пользе и ценности документации на то и на это. Ему же платить за время. Если клиент понимает, что документация ему сократит расходы на внедрение или поддержку, то вот эту конкретную документацию целесообразно написать.
источник

AG

Alexey Golubev in DocOps-сообщество
Нашим клиентам, в большинстве случаев, удобо. К тому же, как вы отметили - есть конвертация в pdf/word.
md привлекает просто-то отслеживания изменений и истории документа и тем, что эта история может дать ответы о том, почему были приняты те или иные решения.
источник

NV

Nick Volynkin in DocOps-сообщество
> Продуктная документация (ака Техническая документация)

разбивается ещё на три категории:
— как разрабатывать: требования, спецификации
— как уже сделано: архитектурная, API
— как (зачёркнуто «с этим теперь жить») этим пользоваться
источник