Size: a a a

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

2018 October 11

NV

Nick Volynkin in DocOps-сообщество
Нужны умные инклюды )
источник

NV

Nick Volynkin in DocOps-сообщество
А если это инфраструктурный код или SQL, то тестирование становится очень интересным
источник

NV

Nick Volynkin in DocOps-сообщество
Но, наверное, и с этим можно справиться )
источник

ЕР

Екатерина Рудская in DocOps-сообщество
Та же DITA их поддерживает, и примеры кода вполне живут отдельно.
Можно даже одним файлом. Но оказалось не слишком удобно, много мороки с выставлением начала и конца инклюда. Или все едет, как только строк больше становится.
источник

NV

Nick Volynkin in DocOps-сообщество
Екатерина Рудская
Та же DITA их поддерживает, и примеры кода вполне живут отдельно.
Можно даже одним файлом. Но оказалось не слишком удобно, много мороки с выставлением начала и конца инклюда. Или все едет, как только строк больше становится.
А внутри XML как их тестировать?
источник

ЕР

Екатерина Рудская in DocOps-сообщество
Nick Volynkin
А внутри XML как их тестировать?
А вот это я еще только буду думать, как делать.
источник

NV

Nick Volynkin in DocOps-сообщество
👋
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Если тема еще актуальна, был такой опыт, когда писал статью про plantUML. В статье приводятся примеры кода и результат -- сами диаграммы в графическом представлении. Естественно, в статье необходимо было показывать только куски кода диаграмм. В Asciidoctor есть удобный инструмент, позволяющий создавать тэги через комментарий, например, так

... обеспечивающий код
'tag::esnc[]
c1 --() i1
c2 --( i1
'end::esnc[]
... обеспечивающий код

Апостроф в PlantUML -- это символ комментария.

И далее при включении в документ используется такой синтаксис:

[source]
----
include::example.pu[tags=esnc]
----
image::example.png[]

Т.е. мы получаем исходный код и картинку.

Естественно, перед сборкой документа диаграммы компилировались. Для PlantUML -- это ключевой тест. Но если бы это был не PlantUML'ный код, вполне можно было бы навесить на него тесты.
источник

NV

Nick Volynkin in DocOps-сообщество
Эта тема актуальна и будет такой ещё долго )
источник

OI

Olga Ilchukova in DocOps-сообщество
Привет! Мы тут любим новичков и просим их рассказать о себе :)
источник

OI

Olga Ilchukova in DocOps-сообщество
и тебе привет!
источник

AK

Artem Krosheninnikov in DocOps-сообщество
Приветы! Я не техпис, но захотелось посмотреть, как у вас кухня устроена и что обсуждаете
источник

OI

Olga Ilchukova in DocOps-сообщество
так мы вам все тут и рассказали :-Р
источник

НН

Нац Нац in DocOps-сообщество
Внатуре, как голым себя почувствовал
источник

OI

Olga Ilchukova in DocOps-сообщество
источник

V

Vlad [Krd] in DocOps-сообщество
Olga Ilchukova
Привет! Мы тут любим новичков и просим их рассказать о себе :)
Привет! А хешик надо какой ставить?)

#о_себе Я - архитектор/тимлид/системный аналитик на 4х проектах в одном крупном операторе связи (точнее его дочке-подрядчике). Собственно, одна из моих задач - внедрение процессов по заведению и поддержке в актуальном состоянии тех документации по проектам, включая архитектуру самих систем, интеграционное взаимодействие и описание внутренней реализации. Что-то веду непосредственно я, что-то - даю примеры или шаблоны для разработчиков и аналитиков.
источник

NV

Nick Volynkin in DocOps-сообщество
Vlad [Krd]
Привет! А хешик надо какой ставить?)

#о_себе Я - архитектор/тимлид/системный аналитик на 4х проектах в одном крупном операторе связи (точнее его дочке-подрядчике). Собственно, одна из моих задач - внедрение процессов по заведению и поддержке в актуальном состоянии тех документации по проектам, включая архитектуру самих систем, интеграционное взаимодействие и описание внутренней реализации. Что-то веду непосредственно я, что-то - даю примеры или шаблоны для разработчиков и аналитиков.
Добро пожаловать. Хешик пока не придумали, а пора бы )
источник

V

Vlad [Krd] in DocOps-сообщество
#о_себе ?)
источник

V

Vlad [Krd] in DocOps-сообщество
А направили меня сюда вот с этим вопросом
источник

NV

Nick Volynkin in DocOps-сообщество
Artem Krosheninnikov
Приветы! Я не техпис, но захотелось посмотреть, как у вас кухня устроена и что обсуждаете
Про кухню я пишу в @docops )
источник