Накипело 😡
Иногда кажется, что главная проблема в IT 〰️ не легаси, не Kubernetes и даже не Прод в пятницу.
Главная проблема 〰️ когда люди, ДАЛЁКИЕ от инженерной работы, начинают решать, какими инструментами должны пользоваться разработчики, DevOps-инженеры и поддержка.
Удобнее кому❓
Word 〰️ отличный инструмент для договоров, приказов и служебных записок. Но когда в документе десятки bash-команд, SQL-запросов, YAML, JSON и конфигов 〰️ это уже не документ, а техническая инструкция.
Технические инструкции должны жить в технических форматах
✅ Markdown (.md)
✅ обычный текст (.txt)
✅ рядом с кодом в Git.
Почему❓
🔵 Команды копируются без сюрпризов (Ах, Вы не сталкивались? Ну так это Вы не сталкивались!)
🔵 Git показывает историю изменений построчно
🔵 Можно делать Pull Request и ревью
🔵 Работает в VS Code, Obsidian, GitHub, GitLab и терминале
🔵 Не нужно открывать тяжёлый офисный редактор ради одной команды
А что умеет Word❓
✅ Случайно заменить символы
✅ Сломать форматирование
✅ Сделать копирование команд менее предсказуемым
✅ Превратить дифф в головную боль
Самое печальное 〰️ не то, что кто-то любит Word.
Самое печальное 〰️ когда человек, не работающий с технической документацией ежедневно и с тем что находится в ней, начинает навязывать её формат тем, кто потом по этим инструкциям ночью поднимает Прод, ищет причину аварии или делает откат релиза.
Инструмент должен подбираться под задачу, а не под личные привычки!
Именно из таких мелочей потом рождаются процессы, которые тормозят всю команду. Не потому, что так требует технология, а потому что так привыкли.
Всем бобра! 👋
#Markdown #Документация #Runbook #DevOps
Иногда кажется, что главная проблема в IT 〰️ не легаси, не Kubernetes и даже не Прод в пятницу.
Главная проблема 〰️ когда люди, ДАЛЁКИЕ от инженерной работы, начинают решать, какими инструментами должны пользоваться разработчики, DevOps-инженеры и поддержка.
— Сделайте чек-лист в Word. Так удобнее.
Удобнее кому❓
Word 〰️ отличный инструмент для договоров, приказов и служебных записок. Но когда в документе десятки bash-команд, SQL-запросов, YAML, JSON и конфигов 〰️ это уже не документ, а техническая инструкция.
Технические инструкции должны жить в технических форматах
✅ Markdown (.md)
✅ обычный текст (.txt)
✅ рядом с кодом в Git.
Почему❓
🔵 Команды копируются без сюрпризов (Ах, Вы не сталкивались? Ну так это Вы не сталкивались!)
🔵 Git показывает историю изменений построчно
🔵 Можно делать Pull Request и ревью
🔵 Работает в VS Code, Obsidian, GitHub, GitLab и терминале
🔵 Не нужно открывать тяжёлый офисный редактор ради одной команды
А что умеет Word❓
✅ Случайно заменить символы
✅ Сломать форматирование
✅ Сделать копирование команд менее предсказуемым
✅ Превратить дифф в головную боль
Самое печальное 〰️ не то, что кто-то любит Word.
Самое печальное 〰️ когда человек, не работающий с технической документацией ежедневно и с тем что находится в ней, начинает навязывать её формат тем, кто потом по этим инструкциям ночью поднимает Прод, ищет причину аварии или делает откат релиза.
Инструмент должен подбираться под задачу, а не под личные привычки!
Именно из таких мелочей потом рождаются процессы, которые тормозят всю команду. Не потому, что так требует технология, а потому что так привыкли.
Всем бобра! 👋
#Markdown #Документация #Runbook #DevOps