Size: a a a

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

2020 February 12

ИУ

Илья Улеско in DocOps-сообщество
Maksim Lapshin
> только по текстовому диффу будет легче понять,

не так. Только текстовый дифф дает возможность понять разницу

> будет проще положить в гит сами изображения

да, положить проще

> глазом практически сразу видны все необходимые изменения

А вот это конечно нет, особенно на мелких картинках.

Я сейчас делаю железо, в нём на одной плате 16 тыс связей. Инструментарий прямо скажем убогенький
А вот тут классный пример про 16к связей! На таком объёме это действительно может быть полезно. Но тут нюанс со сферой деятельности. Я имел минимальный опыт с описанием схем на VHDL, и по моим ощущениям это всё же больше программирование как таковое, нежели именно рисование. Потому тут подходы работы с кодом действительно актуальнее.

>Инструментарий прямо скажем убогенький
А про какой инструментарий идёт речь?
источник

ML

Maksim Lapshin in DocOps-сообщество
Nick Volynkin
Максим, а что если бы связи на плате описывались синтаксисом языка программирования, как в примере выше? Тогда можно было бы использовать средства самого языка для проверки логики-связности-прочего, да и для моделирования. Что ты об этом думаешь?
мне если честно, вообще странно в 2020-м году видеть всерьёз какое-то обсуждение о том, что к документации можно относиться хоть как-то кроме  как к исходникам, из которых генерируются различные представления.

Основной объём работы техписа  — текст. То, что скринкасты и скриншоты пока нет особой практики генерировать скриптами — это недоработка инструментария.

Почти всё сводится к простому тексту.

Инструментально техписатели очень близки к девелоперам.
источник

ML

Maksim Lapshin in DocOps-сообщество
Илья Улеско
А вот тут классный пример про 16к связей! На таком объёме это действительно может быть полезно. Но тут нюанс со сферой деятельности. Я имел минимальный опыт с описанием схем на VHDL, и по моим ощущениям это всё же больше программирование как таковое, нежели именно рисование. Потому тут подходы работы с кодом действительно актуальнее.

>Инструментарий прямо скажем убогенький
А про какой инструментарий идёт речь?
я про графические клик-клик инструменты. Они могут быть удобны для одного человека,  сидящего у компьютера, но начинают разламываться как только начинает работать два человека
источник

ИУ

Илья Улеско in DocOps-сообщество
Maksim Lapshin
мне если честно, вообще странно в 2020-м году видеть всерьёз какое-то обсуждение о том, что к документации можно относиться хоть как-то кроме  как к исходникам, из которых генерируются различные представления.

Основной объём работы техписа  — текст. То, что скринкасты и скриншоты пока нет особой практики генерировать скриптами — это недоработка инструментария.

Почти всё сводится к простому тексту.

Инструментально техписатели очень близки к девелоперам.
Как вариант есть такое видение:
https://idratherbewriting.com/2017/06/02/when-docs-are-not-like-code/
источник

ИУ

Илья Улеско in DocOps-сообщество
Maksim Lapshin
я про графические клик-клик инструменты. Они могут быть удобны для одного человека,  сидящего у компьютера, но начинают разламываться как только начинает работать два человека
Поэтому выше я и писал о том, что у каждого свои подходы и условия.
источник

rd

rus dacent in DocOps-сообщество
Nick Volynkin
Спросим автора поста. @rusdacent ты уже успел заюзать?
Порисовал, но не в проде, потому что в нём всё "по старинке".

Мне нравится. Я вообще люблю всё as a code =)
источник

FM

Fox Mulder in DocOps-сообщество
Maksim Lapshin
мне если честно, вообще странно в 2020-м году видеть всерьёз какое-то обсуждение о том, что к документации можно относиться хоть как-то кроме  как к исходникам, из которых генерируются различные представления.

Основной объём работы техписа  — текст. То, что скринкасты и скриншоты пока нет особой практики генерировать скриптами — это недоработка инструментария.

Почти всё сводится к простому тексту.

Инструментально техписатели очень близки к девелоперам.
Скажите это тем, кто до сих пор пишет в ворде и: re: (re:(re..))
источник

NV

Nick Volynkin in DocOps-сообщество
Ещё раз спрошу, как насчёт онлайн-конфы? Мы так смогли бы охватить слушателей не в дефолт-сити.
источник

A

Angela in DocOps-сообщество
Nick Volynkin
Ещё раз спрошу, как насчёт онлайн-конфы? Мы так смогли бы охватить слушателей не в дефолт-сити.
я думаю, многие согласятся, можно выбрать несколько вариантов времени
источник

ML

Maksim Lapshin in DocOps-сообщество
> Engineers like to release updates a lot less frequently than tech writers

Это разговор из серии «ой, ну не все же ещё перешли на системы контроля версий».

Сегодняшние практики программирования позволяют релизиться несколько раз в день и квартальные релизы означают очень древний процесс.

> you usually push it through a QA process

просто не читай это. эта статья про очень старые реалии
источник

KV

Kamilla Vinokurova in DocOps-сообщество
Nick Volynkin
Ещё раз спрошу, как насчёт онлайн-конфы? Мы так смогли бы охватить слушателей не в дефолт-сити.
👍👍
источник

FM

Fox Mulder in DocOps-сообщество
На хабре недавно была статья, почему в яндексе отказались от недельных релизов. А вы про каждый день ))
источник

ME

Maria Ermakovich in DocOps-сообщество
Nick Volynkin
Ещё раз спрошу, как насчёт онлайн-конфы? Мы так смогли бы охватить слушателей не в дефолт-сити.
а стикеры будут?)
источник

ML

Maksim Lapshin in DocOps-сообщество
Fox Mulder
На хабре недавно была статья, почему в яндексе отказались от недельных релизов. А вы про каждый день ))
не читал эту статью, но такая формулировка мягко говоря некорректна.

В яндексе огромное количество команд и в большинстве канареечные деплои, т.е. само понятие «релиз» очень размазано.

В любом случае, это всё не имеет никакого отношения к документации.

Аргумент вида «девелоперы релизятся раз в квартал, а мы пишем  ежедневно, поэтому гит нам не годится» — это настолько нелепо и глупо, что даже обсуждать непонятно что.
источник

NV

Nick Volynkin in DocOps-сообщество
Maksim Lapshin
не читал эту статью, но такая формулировка мягко говоря некорректна.

В яндексе огромное количество команд и в большинстве канареечные деплои, т.е. само понятие «релиз» очень размазано.

В любом случае, это всё не имеет никакого отношения к документации.

Аргумент вида «девелоперы релизятся раз в квартал, а мы пишем  ежедневно, поэтому гит нам не годится» — это настолько нелепо и глупо, что даже обсуждать непонятно что.
Мы (Plesk) доки релизим сейчас от 1 до 10 раз в день.
источник

NV

Nick Volynkin in DocOps-сообщество
релизноты в разных продуктах, статьи новые, опечатки исправили, переводы обновились
источник

L

Lana in DocOps-сообщество
Nick Volynkin
Ещё раз спрошу, как насчёт онлайн-конфы? Мы так смогли бы охватить слушателей не в дефолт-сити.
Я за, по этой теме или другой? Нужен какой-то gotomeeting нам наверно да?
источник

ML

Maksim Lapshin in DocOps-сообщество
а чего стоит возможность, например, прикрутить грамматическую проверялку и показать техписателям, как их грамотность  меняется во времени за последние 2-3 года?

Легко делается с современным инструментарием и никак не делается вордом.
источник

NV

Nick Volynkin in DocOps-сообщество
Lana
Я за, по этой теме или другой? Нужен какой-то gotomeeting нам наверно да?
Мне кажется, Zoom проплаченный подойдет. Но я поисследую ещё.
источник

v

vladimir in DocOps-сообщество
Nick Volynkin
Мне кажется, Zoom проплаченный подойдет. Но я поисследую ещё.
skype (с видео)/discord для связи лекторов + obs для настройки картинки (+запись трансляции) + youtube/twitch для трансляции
источник