Size: a a a

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

2018 August 05

ML

Maksim Lapshin in DocOps-сообщество
Вроде все обсудили, проговорили и нет: находится один, сидит в чатике и бузу разводит, а конкретного не предлагает
источник

ML

Maksim Lapshin in DocOps-сообщество
И даже напрямую не напишет.
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Nick Volynkin
Написать стайлгайд.
А есть примеры?
источник

NV

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

ИЦ

Игорь Цупко in DocOps-сообщество
Я замахался: пытаюсь на словах концепт донести и как об стену горох
источник

NV

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

ИЦ

Игорь Цупко in DocOps-сообщество
Поняли - да. А на выходе фигня.
источник

NV

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

NV

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

NV

Nick Volynkin in DocOps-сообщество
Четырёх штук пока хватит, наверное )
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Спасибо!
Смущает, что это много букв про буквы. Нет автоматизации никакой, и на выходе может быть как с законами рф
источник

NV

Nick Volynkin in DocOps-сообщество
А вообще @factorized умеет готовить стайлгайды.
источник

NV

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

ИЦ

Игорь Цупко in DocOps-сообщество
Nick Volynkin
Кое-какие проверки ты можешь автоматизировать. Например, что ссылки не битые и что в заголовках капитализация норм, и что в блоках кода указан язык для подсветки синтаксиса.
Вот это меня вообще не парит, честно говоря
источник

NV

Nick Volynkin in DocOps-сообщество
Но для качества скорее полезны будут настроенные процессы.
источник

NV

Nick Volynkin in DocOps-сообщество
Расскажи, что тебя парит )
источник

NV

Nick Volynkin in DocOps-сообщество
Что тебе важно в документации вашей?
источник

NV

Nick Volynkin in DocOps-сообщество
Игорь Цупко
Коллеги, разрешите ворваться к вам.
Проблема: есть пара-тройка человек, которые пополняют внутреннюю базу знаний. И каждый тянет одеяло на себя, не могут договориться о том как структурировать доки, как делать меню, навигацию и прочее.
Как договориться?
В программировании для этого есть фреймворки и паттерны. А с русским языком как быть? ) Он ж не компилируется и автотесты не напишешь.
Можно я это в канал запощу? Пускай ещё люди придут и обсудят )
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Речь про внутркннюю доку, есличто.
Структура и читаемость - чтобы юзер мог это брать и юзать на своем уровне компетенций.
Ненагруженный, неформальный язык и минимум формализма.
Важнее наличие хотя бы паршивой, верхнеуровневой но хорошо структурированной доки (аля вот эта задача решается примерно по таким шагам, копать туды) но раньше, чем хорошо проработанной, но позже.
Важно, чтобы дока внедрялась и юзалась. Важнее всего и даже текста.
источник

ИЦ

Игорь Цупко in DocOps-сообщество
Nick Volynkin
Можно я это в канал запощу? Пускай ещё люди придут и обсудят )
Да!
источник