Size: a a a

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

2019 August 17

OM

Oleg M in DocOps-сообщество
#book  глоссарий ITIL 3v  Rus-Engl
источник

OM

Oleg M in DocOps-сообщество
#book   большой англо-русский толковый научно-технический словарь IT и радиотехн 2016 Кочергин. в 9 томах
источник
2019 August 19

NK

ID:0 in DocOps-сообщество
Ставьте важное вперёд.

Пишет Александр Парень (@SashP84):
Почитываю блоги про авицию. Один из действующих лётчиков разбирает и публикует всякие материалы по тем или иным моментам. Так вот, все помнят, что были две катастрофы Boeing 737MAX, там выяснилось, что была недоработка ПО, но в данном материале пилот отмечает, что оказывается на заметку "Note" в инструкциях никто не обращает внимания.
https://denokan.livejournal.com/207143.html

По ссылке обсуждают инструкцию к самолёту. В ней текст с такой структурой:

Сделайте А
Note: но если выполнено условие X, сначала сделайте Б, иначе случится что-нибудь плохое. (Сделать Б после А технически невозможно).


В критической ситуации человек читает и выполняет первую инструкцию, а потом уже находит вторую. Или не находит. Иногда это приводит к катастрофе.

Вывод автора блога: блок нужно называть Warning, а не Note, и ставить перед остальным текстом. Так у читателя будет меньше шансов пропустить этот блок и больше шансов спасти самолёт.

Не все пишут инструкции к самолётам, но правило-то работает везде. Важное — вперёд.
источник

NV

Nick Volynkin in DocOps-сообщество
Коллеги, а подскажите хороший и регулярно обновляемый докер-образ Sphinx?
источник
2019 August 20

L

Lana in DocOps-сообщество
Nick Volynkin
Коллеги, а подскажите хороший и регулярно обновляемый докер-образ Sphinx?
вот этот вроде норм ddidier/sphinx-doc
источник

L

Lana in DocOps-сообщество
раньше его использовала, но теперь только свой
источник

NV

Nick Volynkin in DocOps-сообщество
Lana
вот этот вроде норм ddidier/sphinx-doc
Спасибо, опробую
источник

L

Lana in DocOps-сообщество
Nick Volynkin
Спасибо, опробую
2 мес назад апдейт
источник
2019 August 21

I

Igor in DocOps-сообщество
Lex
Угу. Не документационный язык
Мне ваша фраза прям засела как-то, не знаю почему.
источник

I

Igor in DocOps-сообщество
Вот тут тоже в документации хороший пример встретил.
источник

I

Igor in DocOps-сообщество
Примеряю на себя и не понимаю как можно писать документацию всегда серьёзно и с кислыми щами
источник

NV

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

На прошлом WTD Prague был целый доклад по то что не надо писать simply.
источник

I

Igor in DocOps-сообщество
Всё понимаю, но всё равно грустно :)
источник

НН

Нац Нац in DocOps-сообщество
Igor
Примеряю на себя и не понимаю как можно писать документацию всегда серьёзно и с кислыми щами
+
источник

NV

Nick Volynkin in DocOps-сообщество
Simply deploy a k8s cluster.

Simply move your app to cloud.

Simply rewrite your app in this new language.
источник

НН

Нац Нац in DocOps-сообщество
Не бывает изи
источник

НН

Нац Нац in DocOps-сообщество
Пушо не всем одинаково изи
источник

D

Daria in DocOps-сообщество
не пишите изи, ради всего святого
источник

НН

Нац Нац in DocOps-сообщество
Нельзя знать кому изи кому нет
источник

L

Lana in DocOps-сообщество
Нац Нац
Не бывает изи
а если бывает, то
источник