https://courses.digitable.life/tags/%D1%82%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%BE%D0%B5-%D0%BF%D0%B8%D1%81%D1%8C%D0%BC%D0%BE/ Recent content in техническое письмо on Digitable courses Hugo -- gohugo.io ru-RU Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/04-adr/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/04-adr/ ADR пишется для инженера, который через два года решит, можно ли снять то, что вы поставили: устройство полей, почему запись нельзя редактировать, разбор плохих и переписанных абзацев контекста и последствий и как отличить живой журнал решений от папки, заполняемой ради аудита. https://courses.digitable.life/post/technical-writing/07-readme/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/07-readme/ README отвечает на три вопроса за шестьдесят секунд — что это, как это запустить и к кому идти дальше; разбираем анатомию файла на парах «плохо / переписано», метрику первого успеха, границу между README и соседними документами и структурные способы не дать ему протухнуть. https://courses.digitable.life/post/technical-writing/05-rfc/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/05-rfc/ RFC — не описание системы, а запрос на возражения до того, как они станут дорогими: когда открыто окно для такого документа, из каких разделов он состоит, как формулировать альтернативы и открытые вопросы, как вести период комментариев и принимать решение, почему RFC устаревает сразу после принятия и что с этим делают структурно. https://courses.digitable.life/post/technical-writing/08-api-docs/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/08-api-docs/ Под словом «документация API» живут три документа с тремя читателями: справочник для того, кто уже пишет код, примеры для того, кто оценивает вас за пятнадцать минут, и контракт для того, кто строит систему поверх вашей. Разбор плохих и переписанных абзацев, генерация против ручного текста, депрекейт как жанр и способ отличить живую документацию от выгрузки Swagger ради регламента. https://courses.digitable.life/post/technical-writing/06-postmortem/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/06-postmortem/ Как написать разбор инцидента, после которого чинят систему: читатель и решение, грамматика обвинения, хронология без послезнания, влияние в числах, проверяемые правки, внешний отчёт и почему постмортемы не устаревают, а становятся невидимыми. https://courses.digitable.life/post/technical-writing/11-maintenance/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/11-maintenance/ Устаревание документа — не следствие лени, а свойство конструкции: разбираем экономику расхождения, классы изменчивости фактов, лестницу проверяемости, владельца и срок жизни, удаление как первоклассную операцию, метрики здоровья документации и ритуальное сопровождение, которое имитирует работу. https://courses.digitable.life/post/technical-writing/13-practice-and-resources/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/13-practice-and-resources/ Почему личный навык письма не переживает увольнение автора, как прикрепить документы к событиям, которые в команде происходят и так, что можно проверить машиной, а что нельзя, какими тремя метриками мерить письмо, как отличить рабочий документ от ритуального в своей организации и с чего начинать квартал внедрения. https://courses.digitable.life/post/technical-writing/12-review/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/12-review/ Протокол ревью инженерного документа: шесть уровней правки и порядок их прохождения, три прохода за двадцать минут, обратный конспект, анатомия действенного комментария, разбор абзацев до и после, как принимать правки, не защищая текст, что отдать линтерам и как ревью удерживает документацию от устаревания. https://courses.digitable.life/post/technical-writing/09-guides-and-tutorials/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/09-guides-and-tutorials/ Туториал, инструкция, раннбук и объяснение — четыре жанра с несовместимыми правилами: что обещает каждый, как выглядит выполнимый шаг, почему обучающие тексты гниют быстрее всех и что с этим делают структурно, как отличить руководство ради читателя от руководства ради процесса. https://courses.digitable.life/post/technical-writing/02-structure/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/02-structure/ Порядок доступа вместо порядка изложения: инвертированная пирамида, первый экран, слои детализации, заголовки-утверждения, выбор между прозой, списком и таблицей, длина как решение и то, как раскладка материала определяет, устареет документ или нет. https://courses.digitable.life/post/technical-writing/10-diagrams/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/10-diagrams/ Схема — такое же утверждение с адресатом и решением, как абзац: она отвечает на один вопрос одного читателя или не нужна вовсе. Что глаз читает лучше текста, а что хуже; разбор плохих и переписанных схем; семантика стрелки и уровни абстракции; почему картинки гниют быстрее прозы и какие структурные меры это лечат; как отличить схему для читателя от схемы для регламента. https://courses.digitable.life/post/technical-writing/00-overview/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/00-overview/ Почему инженерный документ существует только ради решения, которое он должен изменить, и читателя, который это решение примет; какие жанры бывают, почему документация устаревает структурно, как отличить рабочий документ от ритуального и в каком порядке читать четырнадцать глав трека. https://courses.digitable.life/post/technical-writing/01-reader-and-decision/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/01-reader-and-decision/ Технический документ существует ради решения, которое должен принять конкретный читатель: как найти адресата, сформулировать запрос на решение, переписать абзац под него, отличить рабочий документ от процессного и почему тексты без адресата устаревают первыми. https://courses.digitable.life/post/engineering-english/11-writing-clearly/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/engineering-english/11-writing-clearly/ Ясность как инженерная дисциплина, а не как уровень языка: почему потолок мастерства здесь измерим, какие операции правки дают почти весь эффект и как сокращать текст, добавляя в него информацию. https://courses.digitable.life/post/technical-writing/03-clarity/ Thu, 16 Jul 2026 10:00:00 +0300 https://courses.digitable.life/post/technical-writing/03-clarity/ Как устроена ясная фраза в инженерном документе: деятель и действие, известное в начале и новое в конце, каталог двусмысленностей, термины как контракт, модальность вместо «рекомендуется», числа вместо «быстро», линтеры прозы в CI и честный разбор документов, которые мутнеют намеренно.