Статья
Ясность: предложения, термины, двусмысленности
Как устроена ясная фраза в инженерном документе: деятель и действие, известное в начале и новое в конце, каталог двусмысленностей, термины как контракт, модальность …
База знаний
Тема: техническое письмо
15 материалов в этой теме.
Материалы
12 на странице
Статья
Ясность: почему инженерный английский проще разговорного
Ясность как инженерная дисциплина, а не как уровень языка: почему потолок мастерства здесь измерим, какие операции правки дают почти весь эффект и как сокращать текст, …
Статья
Читатель и решение: зачем существует этот документ
Технический документ существует ради решения, которое должен принять конкретный читатель: как найти адресата, сформулировать запрос на решение, переписать абзац под него, …
Статья
Техническое письмо: карта трека и зачем инженеру писать
Почему инженерный документ существует только ради решения, которое он должен изменить, и читателя, который это решение примет; какие жанры бывают, почему документация …
Статья
Схемы в документах: когда рисовать и что именно
Схема — такое же утверждение с адресатом и решением, как абзац: она отвечает на один вопрос одного читателя или не нужна вовсе. Что глаз читает лучше текста, а что хуже; …
Статья
Структура: как расположить материал, чтобы его прочли
Порядок доступа вместо порядка изложения: инвертированная пирамида, первый экран, слои детализации, заголовки-утверждения, выбор между прозой, списком и таблицей, длина …
Статья
Руководства и обучающие тексты: разные жанры, разные правила
Туториал, инструкция, раннбук и объяснение — четыре жанра с несовместимыми правилами: что обещает каждый, как выглядит выполнимый шаг, почему обучающие тексты гниют …
Статья
Ревью текста: как читать чужой документ и как принимать правки
Протокол ревью инженерного документа: шесть уровней правки и порядок их прохождения, три прохода за двадцать минут, обратный конспект, анатомия действенного комментария, …
Статья
Практика и ресурсы: как поставить письмо в процесс команды
Почему личный навык письма не переживает увольнение автора, как прикрепить документы к событиям, которые в команде происходят и так, что можно проверить машиной, а что …
Статья
Почему документация устаревает и что с этим делать структурно
Устаревание документа — не следствие лени, а свойство конструкции: разбираем экономику расхождения, классы изменчивости фактов, лестницу проверяемости, владельца и срок …
Статья
Постмортем: документ, который меняет систему, а не ищет виноватого
Как написать разбор инцидента, после которого чинят систему: читатель и решение, грамматика обвинения, хронология без послезнания, влияние в числах, проверяемые правки, …
Статья
Документация API: справочник, примеры, контракт
Под словом «документация API» живут три документа с тремя читателями: справочник для того, кто уже пишет код, примеры для того, кто оценивает вас за пятнадцать минут, и …
По этому запросу ничего не найдено.