Телеграмм чат группы docsascode страница 596

parrot.ru

Рейтинг популярных групп и каналов

В рейтинге участвует:

групп:

каналов:

Виртуальный сервер на SSD - недорого!

Аренда выделенных и виртуальных серверов (VDS/VPS), хостинг, аренда IP-адресов, администрирование, круглосуточная поддержка

qwarta.ru подробнее

Резервное копирование с проверкой на вирусы!!!

Удобный сервис создания резервных копий на любой сервер сети интернет. Отслеживайте изменения, проверяйте на вирусы. Надежно защитите свой бизнес!

go.backupland.com

Выбираете сервер? Любая конфигурация на заказ!

Аренда физических серверов любых конфигураций под любые запросы - 1С бухгалтерия, игровые сервера, нагруженные проекты, интернет-магазины!

qwarta.ru подробнее

Size: a a a

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

586 membersпожаловаться на группу

2020 February 12

A

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

лет 12 назад, когда ещё никакого докопса не было во всяком случае тут в России, мы работали по похожей схеме в DocBook, держали репозитории в VCS, выпускали версии в один день с релизом продукта, тесно взаимодействовали с разработчиками и тестерами, все наши процессы были в симбиозе с циклом разработки и доставки релиза

источник

13:20пожаловаться #1

AK

Alexander Kosarau in DocOps-сообщество

А является ли документация, собственно, частью исходного кода приложения? Грубо говоря, модуль в системе написал и в этом же модуле лежит документация на него. Обновил модуль > обновил доку. Или это происходит параллельно? И вообще, как советуют в лучших домах Парижа?)

источник

13:20пожаловаться #2

AK

Alexander Kosarau in DocOps-сообщество

Alexander Kosarau

А является ли документация, собственно, частью исходного кода приложения? Грубо говоря, модуль в системе написал и в этом же модуле лежит документация на него. Обновил модуль > обновил доку. Или это происходит параллельно? И вообще, как советуют в лучших домах Парижа?)

Я и не ожидаю ответ 😊 Просто привожу пример тех вопросов, которые у меня возникают по ходу изучения.

источник

13:21пожаловаться #3

A

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

Alexander Kosarau

А является ли документация, собственно, частью исходного кода приложения? Грубо говоря, модуль в системе написал и в этом же модуле лежит документация на него. Обновил модуль > обновил доку. Или это происходит параллельно? И вообще, как советуют в лучших домах Парижа?)

раньше справка могла быть встроена в продукт в формате chm, тогда она поставлялась внутри дистрибутива или релиза, который мог быть выложен на клиентские FTP-сервера
сейчас все двигаются в сторону динамических справочных порталов, не встроенных в продукт, но живущих внутри экосистемы продукта

источник

13:21пожаловаться #4

NV

Nick Volynkin in DocOps-сообщество

Alexander Kosarau

Потому что сейчас в моей голове что-то вроде "Ну они хранят доки в гите и как-то там чото билдят, наверное"

Если кратко, то смысл в том, чтобы обращаться с доками точно так же, как разработчики со своим кодом. Хранить в гите, ревьюить в гите, писать в удобном текстовом редакторе, проверять роботами, собирать роботами, публиковать роботами :)

Техписателю остаётся главное: думать и писать текст. Остальное автоматизируется. Инструменты все те же, что у разработчиков, и это сильно радует ребят из эксплуатации.

источник

13:22пожаловаться #5

FM

Fox Mulder in DocOps-сообщество

Концепция doc as code:
1. Забываем про docx как страшный сон. За использование ворда бить мышкой!
2. Используем один из легковесных языков разметки: md or rst
3. Выбираем движок, который будет генерить документацию из md или rst в ту, что нам нужна
4. Заводим в git or gitlab свую ветку документации
5. Комитим в свою ветку или пул-реквест в ветку мастер.
Радуемся жизни

источник

13:22пожаловаться #6

NV

Nick Volynkin in DocOps-сообщество

Вслед за этим меняются взаимодействия между людьми и командами.

источник

13:22пожаловаться #7

A

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

Если кратко, то смысл в том, чтобы обращаться с доками точно так же, как разработчики со своим кодом. Хранить в гите, ревьюить в гите, писать в удобном текстовом редакторе, проверять роботами, собирать роботами, публиковать роботами :)

Техписателю остаётся главное: думать и писать текст. Остальное автоматизируется. Инструменты все те же, что у разработчиков, и это сильно радует ребят из эксплуатации.

в идеале техпис должен уметь деплоить и конфигурить собственные инструменты тоже

источник

13:22пожаловаться #8

ДС

Денис Старков in DocOps-сообщество

Тут лонг рид как переходили к docs-as-code

Кейс по переходу на Docs-as-code | learnapidoc-ru

Курс по документированию API. Вольный перевод курса https://idratherbewriting.com/learnapidoc/

источник

13:23пожаловаться #9

NV

Nick Volynkin in DocOps-сообщество

в идеале техпис должен уметь деплоить и конфигурить собственные инструменты тоже

Собственно, как и devops — про то что разработчики учатся эксплуатации, а опсы — разработке, и все вместе учатся сотрудничать между собой.

источник

13:23пожаловаться #10

B

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

Fox Mulder

Концепция doc as code:
1. Забываем про docx как страшный сон. За использование ворда бить мышкой!
2. Используем один из легковесных языков разметки: md or rst
3. Выбираем движок, который будет генерить документацию из md или rst в ту, что нам нужна
4. Заводим в git or gitlab свую ветку документации
5. Комитим в свою ветку или пул-реквест в ветку мастер.
Радуемся жизни

Я все это итак делаю. А Хочется, чтоб при изменении в коде - менялся комментарий - менялась дока

источник

13:23пожаловаться #11

A

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

Собственно, как и devops — про то что разработчики учатся эксплуатации, а опсы — разработке, и все вместе учатся сотрудничать между собой.

да, в идеальном мире)))
в реальном все делают свою маленькую часть работы, и какие то большие проблемы или решения спихивают друг на друга

источник

13:24пожаловаться #12

B

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

Денис Старков

Тут лонг рид как переходили к docs-as-code

Кейс по переходу на Docs-as-code | learnapidoc-ru

Курс по документированию API. Вольный перевод курса https://idratherbewriting.com/learnapidoc/

Спасибо)

источник

13:25пожаловаться #13

FM

Fox Mulder in DocOps-сообщество

Burrito

Я все это итак делаю. А Хочется, чтоб при изменении в коде - менялся комментарий - менялась дока

есть материалы гипербатона
https://www.youtube.com/watch?v=6W20lMycgIY&list=PL8i3cg9-YErMG1ZrMNDGUjTQe-p4tRgY3
Посмотрите, там есть интересные вещи.

001. Разработчики, которые документировали сами по себе Алексей Замулла

источник

13:25пожаловаться #14

B

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

Fox Mulder

есть материалы гипербатона
https://www.youtube.com/watch?v=6W20lMycgIY&list=PL8i3cg9-YErMG1ZrMNDGUjTQe-p4tRgY3
Посмотрите, там есть интересные вещи.

001. Разработчики, которые документировали сами по себе Алексей Замулла

Благодарю!)

источник

13:26пожаловаться #15

FM

Fox Mulder in DocOps-сообщество

Чувак из Амазона крут. Читал его статью еще на англ.

источник

13:28пожаловаться #16

NV

Nick Volynkin in DocOps-сообщество

лет 12 назад, когда ещё никакого докопса не было во всяком случае тут в России, мы работали по похожей схеме в DocBook, держали репозитории в VCS, выпускали версии в один день с релизом продукта, тесно взаимодействовали с разработчиками и тестерами, все наши процессы были в симбиозе с циклом разработки и доставки релиза

Вот! Всё новое — хорошо забытое старое :)
Ещё @nmpotashnikoff может рассказать историй про автоматизацию на XML и даже, кажется, LaTeX.

источник

13:33пожаловаться #17

A

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

Вот! Всё новое — хорошо забытое старое :)
Ещё @nmpotashnikoff может рассказать историй про автоматизацию на XML и даже, кажется, LaTeX.

да) в начале карьеры я писала в Latex, у нас тоже были релизы доки, привязанные к релизам продукта, и у нас были даже свои "докопс" инженеры, один из которых уже лет 10 трудится в яндексе на аналогичной позиции

источник

13:34пожаловаться #18

NV

Nick Volynkin in DocOps-сообщество

Пока что могу предложить свой старый доклад на SECR. Там я рассказывал в целом о преимуществах подхода «документация как код», в том числе было про хранение файлов, ревью, переводы и публикацию. https://youtu.be/sVStWzgDnNA

Документация как код в промышленных масштабах

http://0x1.tv/20171020DM Документация как код в промышленных масштабах (Николай Волынкин, SECR-2017) * Николай Волынкин ------------- История о том, как мы в...

@vaaarya и @kosarau_a, может быть вам зайдёт мой доклад. Насколько я помню, там больше о концепции и меньше о деталях реализации. Но я давно его не пересматривал ))

источник

13:34пожаловаться #19

B

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

@vaaarya и @kosarau_a, может быть вам зайдёт мой доклад. Насколько я помню, там больше о концепции и меньше о деталях реализации. Но я давно его не пересматривал ))

Его я уже сохранила в шорт-листе)

источник

13:35пожаловаться #20