Тема: инженерная культура

Статья

Читатель и решение: зачем существует этот документ

Технический документ существует ради решения, которое должен принять конкретный читатель: как найти адресата, сформулировать запрос на решение, переписать абзац под него, …

#техническое письмо#документация#коммуникация

Статья

Чистый код: имена, функции, границы, комментарии

Что на самом деле означает «чистый код»: как называть сущности, какого размера делать функции, как изолировать чужой код на границах системы и когда комментарий полезен, …

#принципы#чистый код#рефакторинг

Статья

Техническое письмо: карта трека и зачем инженеру писать

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

#техническое письмо#документация#коммуникация

Статья

Структура: как расположить материал, чтобы его прочли

Порядок доступа вместо порядка изложения: инвертированная пирамида, первый экран, слои детализации, заголовки-утверждения, выбор между прозой, списком и таблицей, длина …

#техническое письмо#документация#структура текста

Статья

Системные архетипы: повторяющиеся ловушки

Каталог повторяющихся системных структур — от починки, которая ломает, до трагедии общего ресурса — с инженерными примерами, проверяемым предсказанием для каждой …

#системное мышление#системная динамика#архетипы

Статья

Системное мышление: карта трека и зачем это инженеру

Зачем инженеру системная динамика: запасы, потоки, петли и задержки как рабочий инструмент, честный разбор доказательной базы Форрестера и Медоуз, типовые ловушки вроде …

#системное мышление#системная динамика#обратная связь

Статья

Ревью текста: как читать чужой документ и как принимать правки

Протокол ревью инженерного документа: шесть уровней правки и порядок их прохождения, три прохода за двадцать минут, обратный конспект, анатомия действенного комментария, …

#техническое письмо#документация#ревью

Статья

Принципы, которые проверяет машина: типы, линтеры, архитектурные тесты и quality gates

Как превратить договорённости о качестве в автоматические проверки: лестница обратной связи, типы как самый дешёвый гейт, линтеры без раздражения, архитектурные …

#принципы#качество кода#статический анализ

Статья

Принципы разработки: зачем нужны и как не превратить их в карго-культ

Откуда взялись принципы разработки, какую экономическую задачу они решают, чем принцип отличается от правила и как отличить осознанное проектирование от ритуала.

#принципы#проектирование#рефакторинг

Статья

Практика и ресурсы: с чего начать и что читать дальше

Как превратить прочитанное в рабочую практику: одностраничный разбор, журнал предсказаний, стенд на сорок строк Python, двенадцатинедельный план — и честная карта …

#системное мышление#практика#обучение

Статья

Практика и ресурсы: как поставить письмо в процесс команды

Почему личный навык письма не переживает увольнение автора, как прикрепить документы к событиям, которые в команде происходят и так, что можно проверить машиной, а что …

#техническое письмо#документация#инженерная культура

Статья

Почему документация устаревает и что с этим делать структурно

Устаревание документа — не следствие лени, а свойство конструкции: разбираем экономику расхождения, классы изменчивости фактов, лестницу проверяемости, владельца и срок …

#техническое письмо#документация#docs as code