Size: a a a

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

2020 August 31

NV

Nick Volynkin in DocOps-сообщество
Fox Mulder
Это не так. Я бы даже написал - абсолютно не так и этот текст просто грязный поклёп! + полное не понимание того что спрашивают на en-форумах и как спрашивают.
Я всегда в вопросе указываю достаточную для первоначального анализа информацию. Если что-то не будет понятно - привожу еще.
Что же касается "товарищ не читает документацию" - вообще полный абсурд.
==
Тем более, хочу напомнить, что технический писатель - в первую очередь про тексты. Ни 1 ПМ или Заказчику все эти md или adoc с генераторами не нужны. Им нужны тексты. От техписа.
И если я начальнику скажу, что не написал док потому что разбирался в бутстрапе, то меня уволят.
И будут правы.
Потому что поднимать инфраструктуру - это к девопсам,  поднимать визуальный стиль и логику сайта - к фронтам.
И никак иначе. Ибо иначе дойдет до того. что техпис, чтобы задать вопрос в этот чат должен стать сеньором java, тогда товарищ нац-нац позволит разрешить задать вопрос.
Это маразм!
==
Вообщем, я задавать вопросы в этот паблик не буду, читать буду, но не спрашивать.
Пусть его величество нац нац тут правит.
Нет, Никита тут не правит. Более того, вообще больше не участвует в обсуждениях.
источник

NK

ID:0 in DocOps-сообщество
Пишет Игорь Цупко, мой единомышленник и соратник по KnowledgeConf:

Привет, коллеги!

Последний год мы с коллегами из KnowledgeConf занимаемся систематизацией и исследованиями подходов к менеджменту знаний и оформляем это всё в виде Прагматичного Гайда.

Мы выработали ряд походов и понимание того, как запустить или сделать более эффективным онбординг, выстроить документирование, обмен знаниями, сформулировать и распространить лучшие технологические практики внутри команды и компании. И мы хотим поделиться этим знанием с вами.

Если вы сейчас ищете подходы улучшить процессы управления знаниями — давайте пообщаемся и обменяемся опытом. Редакции гайда будет полезно узнать об актуальных для разработчиков проблемах, а вы, возможно, пополните свою копилку хорошими практическими идеями.

Чтобы принять участие — забейте временной слот (30-40 минут) через Calendly. По возможности укажите при забивании слота — какие проблемы менеджмента знаний для вас актуальны, чтобы нам не терять времени.
источник

H

Hartmann in DocOps-сообщество
Граждане, кто-то в последнее время докуменитровал API на каком-нибудь SSG? Не подскажите какую тему использовали или какую взять/рассмотреть лучше/проще на ваш взгляд?
источник

H

Hartmann in DocOps-сообщество
В идеале, конечно, что-нибдуь для Hugo/Jekyll.
источник

NV

Nick Volynkin in DocOps-сообщество
Hartmann
Граждане, кто-то в последнее время докуменитровал API на каком-нибудь SSG? Не подскажите какую тему использовали или какую взять/рассмотреть лучше/проще на ваш взгляд?
Мы как-то пока остановились на Redoc, потому что он генерится на клиенте и поэтому подключается быстро. Но точно будем ещё раз об этом думать и выбирать какой-то с генерацией на сервере.
источник

NK

ID:0 in DocOps-сообщество
Я сам записался, между прочим. И вам рекомендую.
источник

OK

Olya Kirillova in DocOps-сообщество
Можно еще попробовать slate. Он не на jekyll, а на middleman, ну хоть ruby лишний раз ставить не надо.
источник

NV

Nick Volynkin in DocOps-сообщество
В целом, имхо, SSG тут ортогонален (т.е. побоку). Мы можем генерировать документацию инкрементально, по кусочкам. Сначала собрать страницу с API тем инструментом, который идеален для API. Потом включить его в общую документацию как обычный контент.
источник

АВ

Александр Внучков... in DocOps-сообщество
Olya Kirillova
Можно еще попробовать slate. Он не на jekyll, а на middleman, ну хоть ruby лишний раз ставить не надо.
Мы используем у себя Slate. По опыту работы с ним могу сказать, что он хорош для одностраничных API и не слишком гибкий. Но я в своём проекте поменял redcarpet на kramdown, теперь появилась возможность использовать классы и id для элементов (где это необходимо) - отсюда больше возможностей для HTML и JavaScript, если нужно
источник

OK

Olya Kirillova in DocOps-сообщество
@Nick_Volynkin, а вы с redoc не сталкивались с ситуацией, когда несколько файлов со спецификацией api. Получается на каждый файл отдельный инстанс redoc-а? Или я не разобралась еще?
источник

NV

Nick Volynkin in DocOps-сообщество
Olya Kirillova
@Nick_Volynkin, а вы с redoc не сталкивались с ситуацией, когда несколько файлов со спецификацией api. Получается на каждый файл отдельный инстанс redoc-а? Или я не разобралась еще?
На каждый файл отдельная страница, я думаю. Это же разные API?
источник

OK

Olya Kirillova in DocOps-сообщество
Да, расплодили микросервисов :)
источник

NV

Nick Volynkin in DocOps-сообщество
Я бы подумал о том, не связать ли эти страницы общей навигацией вроде меню, либо одной входной страницей.
источник

OK

Olya Kirillova in DocOps-сообщество
Не, ну это конечно.
источник

KV

Konstantin Valeev in DocOps-сообщество
Можно собирать в одну общую доку при желании: https://github.com/WindomZ/swagger-merger

Особенно если API сервисов доступны через общий гейтвей
источник

OK

Olya Kirillova in DocOps-сообщество
Спасибо! Но наверно мерджить не вариант (девелоперы только разделили 😂), тк это будут разные куски продукта, с разным доменом и т.д.
источник

IA

Ivan Abashkin in DocOps-сообщество
Fox Mulder
Это не так. Я бы даже написал - абсолютно не так и этот текст просто грязный поклёп! + полное не понимание того что спрашивают на en-форумах и как спрашивают.
Я всегда в вопросе указываю достаточную для первоначального анализа информацию. Если что-то не будет понятно - привожу еще.
Что же касается "товарищ не читает документацию" - вообще полный абсурд.
==
Тем более, хочу напомнить, что технический писатель - в первую очередь про тексты. Ни 1 ПМ или Заказчику все эти md или adoc с генераторами не нужны. Им нужны тексты. От техписа.
И если я начальнику скажу, что не написал док потому что разбирался в бутстрапе, то меня уволят.
И будут правы.
Потому что поднимать инфраструктуру - это к девопсам,  поднимать визуальный стиль и логику сайта - к фронтам.
И никак иначе. Ибо иначе дойдет до того. что техпис, чтобы задать вопрос в этот чат должен стать сеньором java, тогда товарищ нац-нац позволит разрешить задать вопрос.
Это маразм!
==
Вообщем, я задавать вопросы в этот паблик не буду, читать буду, но не спрашивать.
Пусть его величество нац нац тут правит.
> Ни 1 ПМ или Заказчику все эти md или adoc с генераторами не нужны.

Враки. Я ПМ, мне нужны =)
Точнее я понимаю ценность технологии и как она отразится на моих проектах. Поэтому выделяю ресурсы и разбираюсь сам. У меня над изменением подхода к документированию работает не только техпис, но и несколько других ребят: фронт, девопс, фулстек.

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

FM

Fox Mulder in DocOps-сообщество
Ivan Abashkin
> Ни 1 ПМ или Заказчику все эти md или adoc с генераторами не нужны.

Враки. Я ПМ, мне нужны =)
Точнее я понимаю ценность технологии и как она отразится на моих проектах. Поэтому выделяю ресурсы и разбираюсь сам. У меня над изменением подхода к документированию работает не только техпис, но и несколько других ребят: фронт, девопс, фулстек.

Я к тому, что у тебя есть желание изменить подход к документированию, но ты пытаешься всё делать сам, в одно жало. Попробуй донести ценность инструмента до своих руководителей, чтобы тебе выделили ресурсы для помощи в преодолении технических трудностей. Покажи плюсы инструмента, как он изменит вашу рабочую систему, что станет лучше, быстрее, качественнее и я уверен, что тебе тут же найдут помощника.
Ценность подхода docs-as-code понимает аналитик, еще девопс.
Заказчики хотят word и ничего кроме ворда.
Менеджменту всё равно какая платформа и какие инструменты используются - важен результат.
Есть ворд для заказчиков и есть Confluence для хранения контента.
Остальное - опционально в своё свободное время.
==
Мы, с аналитиком, потихоньку меняем парадигму. Надеюсь преобладаем.
источник

IA

Ivan Abashkin in DocOps-сообщество
Fox Mulder
Ценность подхода docs-as-code понимает аналитик, еще девопс.
Заказчики хотят word и ничего кроме ворда.
Менеджменту всё равно какая платформа и какие инструменты используются - важен результат.
Есть ворд для заказчиков и есть Confluence для хранения контента.
Остальное - опционально в своё свободное время.
==
Мы, с аналитиком, потихоньку меняем парадигму. Надеюсь преобладаем.
А в чем ценность для вас? Как ты видишь эту ценность? Зачем вам нужен doc-as-code?
источник

FM

Fox Mulder in DocOps-сообщество
Ivan Abashkin
А в чем ценность для вас? Как ты видишь эту ценность? Зачем вам нужен doc-as-code?
1. удобство редактирования
2. удобство заимствования
3. удобство распространения
4. удобство совместной работы
5. удобство сборки/версии/отката
==
что-то еще )
источник