LINUX.ORG.RU
ФорумTalks

Где вы храните схемы описания софта, подобные блок-схемам?

 , ,


4

3

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

Где вы размещаете подобные схемы и в чем их рисуете?

Хотелось бы держать это близко к коду, чтобы оно не протухало.

Пока вариант Shinx + png + исходник этого png (в любом формате в котором человек его рисовал, например drawio или tikz или svg)

Как plantuml файлы, в репозитории с продуктом

umren ★★★★★
()

В Fossil есть встроенная Wiki, а также поддержка Markdown, и оба формата поддерживают язык рисования диаграмм Pikchr (всё это плод трудов одного и того же D. Richard Hipp). Но это довольно нишевое решение.

AITap ★★★★★
()

и в чем их рисуете?

dia, yED, LO Draw, InkScape - блок-схему в любом нарисуешь

Kolins ★★★★★
()

PlantUML имеет текстовый формат, можно хранить в той же репе.

Вроде DrawIO тоже сохраняет как XML.

Zhbert ★★★★★
()

Где вы размещаете подобные схемы и в чем их рисуете?

graphviz - текстовые файлы

einhander ★★★★★
()

Где вы размещаете подобные схемы

Например, ./docs/assets/diagrams. На самом деле, какая разница где, главное чтобы в README.md подтягивались ссылки.

и в чем их рисуете?

draw.io или Diagrams

vvn_black ★★★★★
()

PlantUML последнее время asciidoc с интерированными PlantUML, dia и т.п.

Shadow ★★★★★
()
Ответ на: комментарий от Norgat

Как редактировать потом в случае если Miro отменят/или он отменит пользователей из России или просто разорится и закроется?

umren ★★★★★
()

Простые схемы можно делать в mermaid

Gary ★★★★★
()

В системе управления требованиями, очевидно же. В крайнем случае - в Вики.

aiqu6Ait ★★★★
()

Стыдно признаться - в Dia! Он ясный и красивый, но почему-то редкий. Хотелось-бы чтобы такая ясная вещь была у всех.

Недавно установил пиратский офис (пошли мне Господь денег на официальный!). Конечно-же с Visio - без него офис неудобен. Поэтому будем на Visio делать схемы.

pup_kin
()

Хм. Прости, поржал и прослезился. Ну а поскольку это «Talks», то расскажу.
Как-то сдох у знакомых девочек в средней школе сетевой фильтр CraftWay. Типо, для защиты детей от вредной информации. А тут 1 сентября через неделю, а интернет не работает.
Поковырялся, нарисовал на листе A4 примерную схему узлов с IP адресами, переподключил-перенастроил напрямую, и благополучно забыл, естественно.
Через полгода (!) опять звонок - починили девайс, сделай всё обратно, как было. Приезжаю, говорю: «ну откуда ж я помню»? А они мне мной-же нарисованную схему суют, сохранили, не выкинули. =))
За 5 минут переподключил и настроил. Мелочь, а очень приятно было.

cadaber ★★
()
Ответ на: комментарий от pup_kin

пиратский офис (пошли мне Господь денег на официальный)

Если у тебя проблема только с деньгами, тебе повезло. У меня вот на ноуте Windows 8.1. Обновляться на десятку желания нет, он и так не слишком новый. И насколько я понимаю, купить MSO, совместимый с Win8, сегодня официально уже невозможно. (Ткните меня, где, если ошибаюсь.) Покупать новый ноутбук только ради MSO не предлагать.

Я, конечно, прослоупочил, эту проблему надо было решать в 2014 году, пока она не была проблемой. Но сейчас вот… Мы с человеком правили статью с формулами и картинками. Он в MSO 2016, я в LO 7.1. По очереди, промежуточные версии перешвыривали по почте в виде .docx. Лет 7 назад статья бы превратилась в тыкву после 1-2 итераций. А сейчас — прокатило. Текст выжил, формулы выжили, в сборник приняли. Так что с Word+Writer уже вполне можно жить.

Вот насчёт Visio+Draw — не уверен, к сожалению.

hobbit ★★★★★
()
Последнее исправление: hobbit (всего исправлений: 2)
Ответ на: комментарий от hobbit

Надо, впрочем, ответить, что формулы правил только я, мой корреспондент правил только текст, но отображались у него формулы нормально.

hobbit ★★★★★
()
Ответ на: комментарий от hobbit

Обновляться на десятку желания нет, он и так не слишком новый.

Так десятка ведёт себя на слабом железе в разы лучше восьмёрки. Сам был в шоке, когда установил на C2D T5670.

купить MSO, совместимый с Win8, сегодня официально уже невозможно

Кое-где завалялись на складах коробочные издания 2010-2016. Другой вопрос, насколько это имеет смысл.

Ещё есть мутные ЕСовские ключи (с тех пор, как самый-самый верховный суд оправдал UsedSoft GmbH, никто ваще не боится ими торговать), но не знаю, насколько они легальны для зарубежного покупателя.

эту проблему надо было решать в 2014 году

Проблему завязки на инструмент без применения - «текстовый процессор»?

token_polyak ★★★★★
()
Последнее исправление: token_polyak (всего исправлений: 1)
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.