Size: a a a

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

2020 December 05

VS

Vadim Smelyanskiy in DocOps-сообщество
Konstantin Valeev
Ага, например пандок-фильтры :) Мы думали одно время перетащить препроцессорную обработку туда и нормализировать пандоком предварительно в плейн-маркдаун, но как-то не пошло
А, погоди, т.е. в случае с MkDocs будет цепочка Pandoc -> MkDocs?
источник

KV

Konstantin Valeev in DocOps-сообщество
Угу
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Звучит правильно)
источник

KV

Konstantin Valeev in DocOps-сообщество
Надо подумать ещё раз, но это достаточно масштабный рефакторинг
источник

PD

Phil Delgyado in DocOps-сообщество
Vadim Smelyanskiy
С позволения @factorized

Техническая документация – Набор информационных материалов, описывающих разные аспекты
* создания
* внутреннего устройства
* и эксплуатации
технической системы


В этом понимания слова, раздел базы знаний про use case'ы, это документация, которая чуть-чуть про каждый аспект. Она нужна, чтобы
* разраб прочитал и сделал
* тестировщик понял и проверил
* менеджер знал, как передавать в эксплуатацию (на базе кейсов, например, он может заказать написание справки)
Спасибо, но для разной документации в проекте нужны разные процессы, так что из того, что все 'документация' (а туда входят в это определении и все скрипты, например) не следует, что ее всю нужно делать одним способом.
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Phil Delgyado
Спасибо, но для разной документации в проекте нужны разные процессы, так что из того, что все 'документация' (а туда входят в это определении и все скрипты, например) не следует, что ее всю нужно делать одним способом.
Что такое "разные процессы"?
источник

PD

Phil Delgyado in DocOps-сообщество
Разные роли, разные согласования, разная скорость реакции и т.п.
Пропускать вообще все через VCS+сборку неудобно. Да и сборка нужна разная, данные разные и т.п.
источник

PD

Phil Delgyado in DocOps-сообщество
В wiki есть огромный плюс в сравнении с системой сборки теста.
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Phil Delgyado
В wiki есть огромный плюс в сравнении с системой сборки теста.
Какой плюс?
источник

PD

Phil Delgyado in DocOps-сообщество
Простота редактирования, скорость получения результата. А уж в Вики с WYSIWYG редактором и текста и диаграмм - вообще все прекрасно.
Цель wiki класса конфлюенс - доступность для всей компании вплоть до уборщицы.
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Phil Delgyado
Простота редактирования, скорость получения результата. А уж в Вики с WYSIWYG редактором и текста и диаграмм - вообще все прекрасно.
Цель wiki класса конфлюенс - доступность для всей компании вплоть до уборщицы.
Простоту редактирования дают онлайн-IDE, встроенные в ваш любимый сервис для VCS.
Диаграммы - тот же PlantUML в Gitlab'е

Скорость получения результата - настройка инкрементальной сборки
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Не знаю насчёт уборщиц, а дизайнер у нас научилась жать кнопку "Edit", хотя ей никто не показывал, что такая фича вообще есть
источник

H

Hartmann in DocOps-сообщество
ID:0
Гильдии в Plesk, Xsolla, Miro, РТ МИС и Сбере.

Ребята из разных компаний делятся опытом внутренних гильдий, то есть профессиональных сообществ. Только что сам начал смотреть, ничего не напишу в анонсе. Но гильдии — это отличная тема. У нас их аж несколько: QA, devops, frontend, backend, security, accessibility.

Судя по набору компаний, будет чертовски интересно. Рекомендую.

https://youtu.be/rCgXq1i4D9E
Хм. Интересно, одному мне при прочтении «гильдии» немедленно вспомнился старый, добрый WoW?
источник

VA

Viktor Alexandrov in DocOps-сообщество
Vadim Smelyanskiy
Простоту редактирования дают онлайн-IDE, встроенные в ваш любимый сервис для VCS.
Диаграммы - тот же PlantUML в Gitlab'е

Скорость получения результата - настройка инкрементальной сборки
Есть много диаграмм, которые нарисовать в генерируемом виде и без использования элементов графического дизайна — сложно!
источник

PD

Phil Delgyado in DocOps-сообщество
Vadim Smelyanskiy
Простоту редактирования дают онлайн-IDE, встроенные в ваш любимый сервис для VCS.
Диаграммы - тот же PlantUML в Gitlab'е

Скорость получения результата - настройка инкрементальной сборки
Хм, там wysiwyg или что-то еще? Людям, увы, нужно именно оно и не хуже ворда (
Инкрементальная сборка - это уже не "нажал кнопку и увидел"
Ну и нужны инструменты обсуждения поверх документации, уровня того же Confluence
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Viktor Alexandrov
Есть много диаграмм, которые нарисовать в генерируемом виде и без использования элементов графического дизайна — сложно!
Это правда, такие диаграммки приходится складывать в папку

Мы такое либо исходником из draw.io, либо картинкой.
Если допилим препроцессор, будем исходник точно держать в папке.

https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio
источник

VA

Viktor Alexandrov in DocOps-сообщество
Phil Delgyado
Хм, там wysiwyg или что-то еще? Людям, увы, нужно именно оно и не хуже ворда (
Инкрементальная сборка - это уже не "нажал кнопку и увидел"
Ну и нужны инструменты обсуждения поверх документации, уровня того же Confluence
Кому нужен wysiwyg?
источник

KV

Konstantin Valeev in DocOps-сообщество
Vadim Smelyanskiy
Это правда, такие диаграммки приходится складывать в папку

Мы такое либо исходником из draw.io, либо картинкой.
Если допилим препроцессор, будем исходник точно держать в папке.

https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio
О, а допилите :)
источник

VA

Viktor Alexandrov in DocOps-сообщество
Мне кажется те, кому нужен такой подход уже не пишут доки)
источник

VA

Viktor Alexandrov in DocOps-сообщество
В текстовом подходе всё удобнее, кроме того, что надо привыкнуть.
источник