Тема: документация

Статья

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

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

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

Статья

Стандарты и RFC: язык нормативных документов

Как читать нормативный английский стандартов и RFC: ключевые слова BCP 14, разница между MUST, SHOULD и MAY, анатомия документа и как писать требования, которые нельзя …

#английский#документация#стандарты

Статья

Сообщения об ошибках и логи: как читать чужие и писать свои

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

#английский#логирование#отладка

Статья

Системный и бизнес-анализ: кто такой аналитик и что он реально делает

Что за профессия аналитик в IT: какую проблему решает роль, как выглядят её рабочие артефакты — user story, use case, BPMN, ERD, контракт API — и что чаще всего ломается …

#аналитика#требования#бизнес-анализ

Статья

Руководства и обучающие тексты: разные жанры, разные правила

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

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

Статья

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

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

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

Статья

Принятие решений в проекте: типы решений, DACI и RAPID, ADR, эскалация и допуски

Как проект выбирает один вариант из многих: обратимость и цена задержки, модели распределения прав, DACI и RAPID против RACI, допуски и правильная эскалация, ADR как …

#менеджмент#принятие решений#управление проектами

Статья

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

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

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

Статья

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

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

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

Статья

Постмортем: документ, который меняет систему, а не ищет виноватого

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

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

Статья

Поиск для созидателя: карта трека и почему это отдельный навык

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

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

Статья

Первоисточник против пересказа: как дойти до места, где написана правда

Что считать первичным источником в инженерии, какие пять вещей систематически теряются при пересказе, как за несколько минут подняться от чужой статьи к спецификации или …

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