Size: a a a

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

2020 February 11

NK

ID:0 in DocOps-сообщество
Кстати, если вы на конференции и что-то конспектируете, то пуллреквесты приветствуются. Вот шаблон, можно оттуда скопировать «шапку» с метаданными. https://github.com/docops-hq/conf/blob/master/content/teamleadconf/20/documentation_challenges.md
источник

NV

Nick Volynkin in DocOps-сообщество
Вот это ваще опасный парень
источник

NV

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

NK

ID:0 in DocOps-сообщество
Начали голосование за самое страшное преступление против знаний. Преступник получит билет на KnowledgeConf :)

Начало тут: https://t.me/KnowledgeConfChannel/69
источник

L

Lana in DocOps-сообщество
Оч важно, что незапиненных, ищут поиском по чату, все помнят запрос, чтобы найти
источник

NV

Nick Volynkin in DocOps-сообщество
Lana
Оч важно, что незапиненных, ищут поиском по чату, все помнят запрос, чтобы найти
Ахаха, ужасно
источник
2020 February 12

NK

ID:0 in DocOps-сообщество
Diagram as Code for prototyping cloud system architectures
https://github.com/mingrammer/diagrams

Люблю такое
источник

L

Lana in DocOps-сообщество
ID:
Diagram as Code for prototyping cloud system architectures
https://github.com/mingrammer/diagrams

Люблю такое
давайте уже митап замутим
источник

FM

Fox Mulder in DocOps-сообщество
А давайте
источник

L

Lana in DocOps-сообщество
Можно у нас, я договорюсь, человек 60-70 вместимость. Москва-сити. У кого есть интересные кейсы настойки генерации диаграмм из разметки или подобного? Пишите в личку.
источник

FM

Fox Mulder in DocOps-сообщество
Я обычно делаю в draw.io, но мне это надоело!
источник

ИУ

Илья Улеско in DocOps-сообщество
ID:
Diagram as Code for prototyping cloud system architectures
https://github.com/mingrammer/diagrams

Люблю такое
Как технарь смотрю на это с интересом (это ж код!), но как техписатель вижу следующее:
- Когда человек хочет нарисовать диаграмму, он представляет её и в целом оперирует визуальными данными. Способ неважен — ручкой на бумаге или же в среде рисования. Лично я не мыслю текстом в данном процессе, я “вижу” связи.
- Допустим, что требуется описать диаграмму кодом. Получается, будет затрачено лишнее время на преобразование “картинки” в текст?
- Аргумент из серии “это делается быстро” работает на примитивных примерах. Но и примитивный пример выше будет рисоваться так же быстро. Но насколько быстро будет проектирование диаграммы кодом, когда будет диаграмма сложнее и с большим количеством связей/типов?
-  Допустим, что это быстро. Но неужели требуется помнить названия и свойства всех элементов при их описании кодом? В среде рисования эта инфа считывается глазом моментально при выборе шаблона для элемента.
источник

ИУ

Илья Улеско in DocOps-сообщество
- Рассмотрим один из любимых аргументов докопсеров про гит и версионирование, а конкретно момент про диффы. Допустим, есть пара версий диаграммы, разница между которыми в паре отсутствующих элементов. Неужели только по текстовому диффу будет легче понять, как именно перестроились связи и позиции других элементов? Полагаю, что будет проще положить в гит сами изображения, и при задаче сравнения смотреть уже их — глазом практически сразу видны все необходимые изменения и следствия из них.
- Насчёт оформления: если нужно задать порядок, сгруппировать визуально элементы или использовать другие способы улучшения восприятия, то как это делать кодом? И потом для проверки корректности изменений в процессе работы постоянно выполнять сборку?
- Не стоит забывать про возможные баги из-за синтаксиса, которые отсутствуют при рисовании как таковом.
источник

NV

Nick Volynkin in DocOps-сообщество
«Когда человек хочет нарисовать диаграмму, он представляет её и в целом оперирует визуальными данными»

Это ограничение снимается, когда есть хоть небольшой опыт. Когда разработчик интерфейсов (мобильных, веб, любых) хочет нарисовать интерфейс, он представляет его визуально, но пишет на XML, HTML или другом языке разметки. И нормально всё получается.
источник

NV

Nick Volynkin in DocOps-сообщество
«если нужно задать порядок, сгруппировать визуально элементы или использовать другие способы улучшения восприятия, то как это делать кодом»
Для этого в языке разметки обычно есть инструменты.
источник

L

Lana in DocOps-сообщество
Илья Улеско
Как технарь смотрю на это с интересом (это ж код!), но как техписатель вижу следующее:
- Когда человек хочет нарисовать диаграмму, он представляет её и в целом оперирует визуальными данными. Способ неважен — ручкой на бумаге или же в среде рисования. Лично я не мыслю текстом в данном процессе, я “вижу” связи.
- Допустим, что требуется описать диаграмму кодом. Получается, будет затрачено лишнее время на преобразование “картинки” в текст?
- Аргумент из серии “это делается быстро” работает на примитивных примерах. Но и примитивный пример выше будет рисоваться так же быстро. Но насколько быстро будет проектирование диаграммы кодом, когда будет диаграмма сложнее и с большим количеством связей/типов?
-  Допустим, что это быстро. Но неужели требуется помнить названия и свойства всех элементов при их описании кодом? В среде рисования эта инфа считывается глазом моментально при выборе шаблона для элемента.
может замутишь спич на митапе про "почему не надо рисовать диаграммы разметкой?) было бы круто
источник

NV

Nick Volynkin in DocOps-сообщество
«Не стоит забывать про возможные баги из-за синтаксиса, которые отсутствуют при рисовании как таковом.»

Проверить логику и полноту легче в тексте с последовательным изложением, чем на картинке.
источник

ИУ

Илья Улеско in DocOps-сообщество
Lana
может замутишь спич на митапе про "почему не надо рисовать диаграммы разметкой?) было бы круто
Зачем?
У каждого свои потребности и задачи. Если в какой-то компании документацией занимается один человек, то пусть он её ведёт так как ему удобно. Если в компании команда техписов — тут уже другие нюансы. Если тепм такой, что “всё должно было быть вчера”, то уже другие подходы. Есть компании, которые могут потратить ресурсы на дорогостоящий инструментарий — тут вообще другая реальность.
Вопросами выше я расширяю лишь свой кругозор для понимания проблем и решений =)
источник

L

Lana in DocOps-сообщество
Илья Улеско
Зачем?
У каждого свои потребности и задачи. Если в какой-то компании документацией занимается один человек, то пусть он её ведёт так как ему удобно. Если в компании команда техписов — тут уже другие нюансы. Если тепм такой, что “всё должно было быть вчера”, то уже другие подходы. Есть компании, которые могут потратить ресурсы на дорогостоящий инструментарий — тут вообще другая реальность.
Вопросами выше я расширяю лишь свой кругозор для понимания проблем и решений =)
ну вот в том-то и дело, что тут чат не про техписов, было бы интересно послушать и подискутировать, поищу еще кого-то кто может на эту тему высказаться. митап планируем в середине марта
источник

ИУ

Илья Улеско in DocOps-сообщество
Nick Volynkin
«Не стоит забывать про возможные баги из-за синтаксиса, которые отсутствуют при рисовании как таковом.»

Проверить логику и полноту легче в тексте с последовательным изложением, чем на картинке.
Не, про логику это уже скорее отдельный плюс у этого подхода. Я именно про проблемы возможных правил синтаксиса, когда интерпретатор не сможет явным образом определить, какую конструкцию следует использовать первой из нескольких конкурирующих.
источник