Size: a a a

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

2019 July 27

ДБ

Дмитрий Башкирцев in DocOps-сообщество
Если будет контекст, типа откройте sh файл, найдите строку (тут строка с диезом из примера) и раскомментируйте
источник

NV

Nick Volynkin in DocOps-сообщество
Про вводную часть в целом согласен, но не все читают вводную часть. Обычно люди поиском находят документ и в нём читают нужный кусок. Every page is page one. Поэтому хорошо бы в каждом примере кода доносить это различие.
источник

ДБ

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

NV

Nick Volynkin in DocOps-сообщество
например, так, ага
источник

NV

Nick Volynkin in DocOps-сообщество
или где-нибудь в шапке блока кода
источник

ДБ

Дмитрий Башкирцев in DocOps-сообщество
У меня, блин, щас идея-фикс графоманить в латехе...
источник

ДБ

Дмитрий Башкирцев in DocOps-сообщество
источник

NV

Nick Volynkin in DocOps-сообщество
Там есть ещё интересное дополнительное требование: кнопка «копировать код», которая бы не копировала эти приветствия. Разумеется, они не нужны при копировании.
источник

NV

Nick Volynkin in DocOps-сообщество
Значит их нужно добавлять CSS-ом. Значит, нужны два класса.
источник

NV

Nick Volynkin in DocOps-сообщество
Дмитрий Башкирцев
Димитрий Башкирцевич
​Как на счет использования латеха для документации?

Димитрий Башкирцевич
​насколько это маргинально и нецелесообразно?

Димитрий Башкирцевич
​насколько хорошо использовать ограниченное количество веток для ведения документации? не используете ли ветки с именами задач? или вы брэнчитесь от эпик/фич веток?

Димитрий Башкирцевич
​при сквоше блэйм удобно смотреть?
Про латех. Думаю, что прямо на латехе писать — это слишком сложно и займёт неоправданно много времени. Но много где используют готовые шаблоны на латехе, чтобы генерировать PDF, например.
источник

L

Luiza in DocOps-сообщество
Тут кстати тестировать одним дали.. А они спрашивают под кем команду делать, уточните по тексту от какого пользователя, а то написано только: # apt-get install...
источник

NV

Nick Volynkin in DocOps-сообщество
Luiza
Тут кстати тестировать одним дали.. А они спрашивают под кем команду делать, уточните по тексту от какого пользователя, а то написано только: # apt-get install...
Хех ))
источник

L

Luiza in DocOps-сообщество
Так говорю, квалификация читателя подразумевает..
источник

ДБ

Дмитрий Башкирцев in DocOps-сообщество
Luiza
Тут кстати тестировать одним дали.. А они спрашивают под кем команду делать, уточните по тексту от какого пользователя, а то написано только: # apt-get install...
Закон мерфи прям
источник

NV

Nick Volynkin in DocOps-сообщество
Luiza
Так говорю, квалификация читателя подразумевает..
Если подразумевается средняя (медианная) квалификация читателя, то половина читателей ниже этой квалификации. ))
источник

ТД

Толик Дуров с поселка in DocOps-сообщество
Luiza
Тут кстати тестировать одним дали.. А они спрашивают под кем команду делать, уточните по тексту от какого пользователя, а то написано только: # apt-get install...
не каждый задумывается,  я думаю кто терминал часто видит только. У меня есть "не мой" сервер куда мне только root дали доступ,  может ттолько поэтому я задумался про разницу  в первом символе
источник

NV

Nick Volynkin in DocOps-сообщество
А у меня zsh + oh-my-zsh, так что приветствие терминала выглядит совсем не так )
источник

NV

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

V

Vanger in DocOps-сообщество
Nick Volynkin
А у меня zsh + oh-my-zsh, так что приветствие терминала выглядит совсем не так )
+ очень удобная связка
источник

NV

Nick Volynkin in DocOps-сообщество
Vanger
+ очень удобная связка
Кажется, меня вдохновил вот этот пост https://habr.com/ru/post/323496/.
До этого был просто zsh.
источник