Size: a a a

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

2019 January 08

АК

Анатолий Клюса in DocOps-сообщество
Nick Volynkin
@NortaBirdo автоматизировал документирование баз данных, может знать
Спасибо!
источник

Н

Николай in DocOps-сообщество
Правда есть проблемка - там нельзя задавать ширину холста, так что большие схемы выглядят так себе
источник

АК

Анатолий Клюса in DocOps-сообщество
Николай
Не уверен про "принято" но plantuml нормально пашет
Спасибо, посмотрю!
Я пока астах использую и на визуал парадигму посматриваю, но если есть варианты близко к пл/скл...
источник

Н

Николай in DocOps-сообщество
Близко - это парсеры своего изготовления
источник

Н

Николай in DocOps-сообщество
Если по схеме данных, то при заданных FK проблема решается кучей тулзов, многие студии умеют это из коробки.
источник

Н

Николай in DocOps-сообщество
А вот логику и апи, тут голову надо будет поломать. Сильно зависит от архитектуры проекта
источник

NV

Nick Volynkin in DocOps-сообщество
Ну и самое время дать ссылку на фундаментальный труд
https://telegra.ph/Uchimsya-risovat-grafiki-v-dokumentacii-bez-dizajnera-i-talanta-07-12
источник

НН

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

АК

Анатолий Клюса in DocOps-сообщество
Николай
Близко - это парсеры своего изготовления
Видел visustin и umlcode, последний вообще сугубо для пл/скл, но первый чисто для схем, без uml, а второй генерит только визуально, не перенесёшь в тот же астах и парадигму...
О... Буду и Ваше творение посмотреть!))
источник

НН

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

NV

Nick Volynkin in DocOps-сообщество
А вот и автор )
источник

ME

Maria Ermakovich in DocOps-сообщество
ето мой любимый труд)
источник
2019 January 09

SB

Sergey Bronnikov in DocOps-сообщество
Привет! В мире юникс стандартом для написания системной документации является roff (groff, mandoc). Скажите, а за пределами юникса этот формат и тулзы используют для написания документации?
источник

NV

Nick Volynkin in DocOps-сообщество
Не встречал ни разу. Это же почти всегда документация для CLI-приложений.
источник

NV

Nick Volynkin in DocOps-сообщество
Кстати, Sphinxdoc может выгружать доки в roff, это куда удобнее, чем руками писать разметку.
источник

NV

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

I

Igor in DocOps-сообщество
Я помню пассаж в pragmatic programmer что они писали книгу в groff, но потом опомнились и перешли на tex

Если вёрстка несложная, то можно писать в md и потом конвертить через pandoc. С техом так точно делают некоторые
источник

SB

Sergey Bronnikov in DocOps-сообщество
Ага. Еще есть рассказ Кернигана как они писали "The Go Programming Language" https://rkrishnan.org/posts/2016-03-07-how-is-gopl-typeset.html LATeX у них не пошел и они XML конвертировали в troff и из него уже генерировали PDF.
источник

I

Igor in DocOps-сообщество
фигасе. Я был уверен, что troff это такая некрофилия
источник

TZ

Timofey Zakrevskiy in DocOps-сообщество
Sergey Bronnikov
Ага. Еще есть рассказ Кернигана как они писали "The Go Programming Language" https://rkrishnan.org/posts/2016-03-07-how-is-gopl-typeset.html LATeX у них не пошел и они XML конвертировали в troff и из него уже генерировали PDF.
Восхитительно. "Мы не смогли в ЛаТеХ, поэтому мы решили всё сделать в XML". Это ж надо настолько не справиться с латехом...
источник