НН
В спеке CommonMark нет таблиц
Вы про какой-то конкретный парсер?
Вы про какой-то конкретный парсер?
Github FM
Size: a a a
2019 January 15
L
Github FM
git flavor
АК
Хочу внести ясность, я больше спец по реляционным субд и pl/sql, я не совсем силён в теме этого канала.
Но мне нужно составить документацию по пл/скл коду с дальнейшим замахом на документацию по всему предприятию.
СУБД у нас оракловая, да, там есть и таблицы, мы их описывали в каких-то средствах типа ER-студии и прочих... Ну, то есть нужны и ER-диаграммы в дальнейшем, думаю...
Но мне нужно составить документацию по пл/скл коду с дальнейшим замахом на документацию по всему предприятию.
СУБД у нас оракловая, да, там есть и таблицы, мы их описывали в каких-то средствах типа ER-студии и прочих... Ну, то есть нужны и ER-диаграммы в дальнейшем, думаю...
VS
Github FM
А можете подсказать под JVM или JS какой-нибудь парсер AST этого диалекта?
АК
Т.е. да, таблицы есть, есть код на пл/скл, есть код на яве и на делфи...
Есть система документооборота...
Есть система документооборота...
НН
А можете подсказать под JVM или JS какой-нибудь парсер AST этого диалекта?
VS
О, действительно
Мне почему-то казалось, что remark только чистый стандарт читает
Спасибо!
Мне почему-то казалось, что remark только чистый стандарт читает
Спасибо!
VS
А вообще, почему я задавался вопросом: для MD инструментов много, но фичи порой отличаются
Для RST инструментов меньше, зато стандарт единый
Для RST инструментов меньше, зато стандарт единый
NV
А вообще, почему я задавался вопросом: для MD инструментов много, но фичи порой отличаются
Для RST инструментов меньше, зато стандарт единый
Для RST инструментов меньше, зато стандарт единый
И стандартный интерфейс для расширения синтаксиса
NP
Т.е. да, таблицы есть, есть код на пл/скл, есть код на яве и на делфи...
Есть система документооборота...
Есть система документооборота...
На самом деле, подвох только в том, что md/rst/asciidoc+plantuml/...+vcs — серьёзный путь, но отдача — не менее серьёзная. По сути, моё мнение, даже близкой альтернативы с точки зрения долгосрочной эффективности — нет.
NP
Хочу внести ясность, я больше спец по реляционным субд и pl/sql, я не совсем силён в теме этого канала.
Но мне нужно составить документацию по пл/скл коду с дальнейшим замахом на документацию по всему предприятию.
СУБД у нас оракловая, да, там есть и таблицы, мы их описывали в каких-то средствах типа ER-студии и прочих... Ну, то есть нужны и ER-диаграммы в дальнейшем, думаю...
Но мне нужно составить документацию по пл/скл коду с дальнейшим замахом на документацию по всему предприятию.
СУБД у нас оракловая, да, там есть и таблицы, мы их описывали в каких-то средствах типа ER-студии и прочих... Ну, то есть нужны и ER-диаграммы в дальнейшем, думаю...
Мне кажется наиболее разумным для документации БД — хранить документацию прямо в миграционных скриптах, далее для генерации человеческой документации сделать пайп -лайн , который превращает миграционные скрипты в md/rst/asciidoc и plant-uml диаграммы и далее в статический сайт, pdf, word.. что угодно. Это гарантирует актуальность документации при минимуме усилий. Вот здесь мой доклад, на эту тему https://2018.secrus.org/program/submitted-presentations/applying-documentation-as-code-practice/
АК
Мне кажется наиболее разумным для документации БД — хранить документацию прямо в миграционных скриптах, далее для генерации человеческой документации сделать пайп -лайн , который превращает миграционные скрипты в md/rst/asciidoc и plant-uml диаграммы и далее в статический сайт, pdf, word.. что угодно. Это гарантирует актуальность документации при минимуме усилий. Вот здесь мой доклад, на эту тему https://2018.secrus.org/program/submitted-presentations/applying-documentation-as-code-practice/
Миграционных скриптов нет )), но есть комментарии к столбцам и таблицам, в оракле хорощо работать с метаданными)
Жаль, каменты заполняют не всегда)
Я писал скрипт для вытягивания каментов в доку и в описания процедур...
Более интересен выбор описания кода: блок-схемы, другие варианты...
Жаль, каменты заполняют не всегда)
Я писал скрипт для вытягивания каментов в доку и в описания процедур...
Более интересен выбор описания кода: блок-схемы, другие варианты...
АК
На самом деле, подвох только в том, что md/rst/asciidoc+plantuml/...+vcs — серьёзный путь, но отдача — не менее серьёзная. По сути, моё мнение, даже близкой альтернативы с точки зрения долгосрочной эффективности — нет.
О, это всё надо будет посмотреть, спасибо!
АК
Друзья, спасибо за советы, я неправильно понял, что за зверь аскидок, подумал, что это просто дока в текстовом виде в аскии кодировке, как во времена доса... 😄
Надо покурить всё, что вы тут мне написали )
Надо покурить всё, что вы тут мне написали )
АК
таблицы средствами маркдауна отлично делаются
Как по мне, то для таблиц ER-диаграммы - это классика... или я отстал от жизни? Я про реляционные субд ессно и про более менее серьёзные бд...
АК
Мне кажется наиболее разумным для документации БД — хранить документацию прямо в миграционных скриптах, далее для генерации человеческой документации сделать пайп -лайн , который превращает миграционные скрипты в md/rst/asciidoc и plant-uml диаграммы и далее в статический сайт, pdf, word.. что угодно. Это гарантирует актуальность документации при минимуме усилий. Вот здесь мой доклад, на эту тему https://2018.secrus.org/program/submitted-presentations/applying-documentation-as-code-practice/
Доклад интересен!
Под такую концепцию хорошо укладывается, например, javadoc, да?
Касательно скриптов БД... да, каменты к полям решают!
Под такую концепцию хорошо укладывается, например, javadoc, да?
Касательно скриптов БД... да, каменты к полям решают!
NP
Как по мне, то для таблиц ER-диаграммы - это классика... или я отстал от жизни? Я про реляционные субд ессно и про более менее серьёзные бд...
Я так понимаю, что вы разные вещи под таблицами понимаете. Таблицы в документе и таблицы в базе)) Дело в том, что рисование (визуальное оформлениетаблиц) — слабое место всех документационных маркапов
АК
Я так понимаю, что вы разные вещи под таблицами понимаете. Таблицы в документе и таблицы в базе)) Дело в том, что рисование (визуальное оформлениетаблиц) — слабое место всех документационных маркапов
Ааа... -))