Size: a a a

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

2020 May 12

НН

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

НН

Нац Нац in DocOps-сообщество
Когда заказчик видит такую диаграмму
источник

H

Hartmann in DocOps-сообщество
Лол.
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Fox Mulder
1. Есть продукт
2. Мы хотим его продать
3. Нашли заказчика
4. Заказчик хочет знать всё про продукт
5. Требует схемы или чертежи
6. Требует общие и частные схемы
7. Просит оформить схему интеграции в существующую ИС
8а. Посылаем заказчика. Не получаем деньги.
8б. Делаем все доки. Продаем продукт. Получаем деньги. Получаем ЗП.
Диаграммы обязательно нужны. И красота нужна. Потому что все, что красиво, все правильно. Понятно, что карту метрополитена в PlantUML не нарисуешь. Но это будет одна образцово-показательная диаграмма на проект. И мозгов в нее нужно много вложить. И уж точно не Visio
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Fox Mulder
https://programmersought.com/images/281/f59a12a15fc31a1651a22dfc3224cf11.png

Как с помощью PlantUML нарисовать такое?
Такие диаграммы, уверен, можно рисовать автоматически с высоким качеством. Конечно, не в PlantUML. Возможно, dot
источник

FM

Fox Mulder in DocOps-сообщество
Nikolaj Potashnikov
Диаграммы обязательно нужны. И красота нужна. Потому что все, что красиво, все правильно. Понятно, что карту метрополитена в PlantUML не нарисуешь. Но это будет одна образцово-показательная диаграмма на проект. И мозгов в нее нужно много вложить. И уж точно не Visio
Все схемы в формате vxsd (вроде такой у визио). У draw.io недавно появилась поддержка экспорта в визио.
источник

FM

Fox Mulder in DocOps-сообщество
Nikolaj Potashnikov
Такие диаграммы, уверен, можно рисовать автоматически с высоким качеством. Конечно, не в PlantUML. Возможно, dot
Надо будет почитать про dot
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Fox Mulder
Все схемы в формате vxsd (вроде такой у визио). У draw.io недавно появилась поддержка экспорта в визио.
И все приведенные диаграммы я бы пытался сделать as code. Они не настолько сложны. Просто искать адекватные средства.
источник

SK

Sergei Kutcher in DocOps-сообщество
Пишу документацию для новых разработчиков. Описываю приложение. Сейчас нахожусь на стадии описания классов (Entity, сервисы, репозитории).
Получается так, что я описываю почти каждый класс в приложении (для чего он нужен, откуда вызывается).

Это вообще правильный подход к описанию?
источник

IC

Ivan Cheban in DocOps-сообщество
Диаграммы тоже рисуете со всеми этими методами, классами?
источник

D

Darwin in DocOps-сообщество
Ramil G
Выглядит круто! Кто пользовался уже?
Идеи автора (с4) очень хорошие, доклад-другой посмотреть стоит. Инструментом пользоваться категорически невозможно, ux это не про моего батю, как говорится в народе.
источник
2020 May 13

L

Lana in DocOps-сообщество
Разработчики внезапно спросили, а есть тула, чтобы из диаграммы генерировать плантумл синтаксис) не наоборот) Встречали такое? Расширений для коде и онлайн эдиторов,делающих обратное для превью куча.
источник

ME

Maria Ermakovich in DocOps-сообщество
Lana
Разработчики внезапно спросили, а есть тула, чтобы из диаграммы генерировать плантумл синтаксис) не наоборот) Встречали такое? Расширений для коде и онлайн эдиторов,делающих обратное для превью куча.
а диаграмма в SVG? тогда возможно есть
источник

ME

Maria Ermakovich in DocOps-сообщество
из png - вряд ли )
источник

L

Lana in DocOps-сообщество
Maria Ermakovich
а диаграмма в SVG? тогда возможно есть
не, типа ты такой рисуешь, а она преобразовывается в синтаксис - им видите ли в лом учить нотацию)
источник

DB

Dima Boger in DocOps-сообщество
А, настолько
источник

ME

Maria Ermakovich in DocOps-сообщество
Lana
не, типа ты такой рисуешь, а она преобразовывается в синтаксис - им видите ли в лом учить нотацию)
они ж нарисуют такого что и не будет преобразовываться)
источник

L

Lana in DocOps-сообщество
Maria Ermakovich
они ж нарисуют такого что и не будет преобразовываться)
поэтому я пока успокоила их превьюшками)
источник
2020 May 15

NK

ID:0 in DocOps-сообщество
Костя Валеев, контрибьютор проекта Foliant, рассказывает про построение инфраструктуры для docs-as-code. Трансляция через 10 минут, подключайтесь: https://youtu.be/6CKVodl2YcA
источник

ВЗ

Владислав Задумов... in DocOps-сообщество
Коллеги, приветствую.
Подскажите пожалуйста инструменты для написания документации с не особо высоким порогом входа в плане инфраструктуры. Получили новый проект, для него нужно практически с нуля оформлять документацию с процессами, вот и собираем варианты.
источник