Статья
Документация Digit по-русски
Ядро документации Digit на русском: три команды, которых нет ни в одной другой документации, и то, без чего не начать — установка, первый запуск, выбор модели, обновление
База знаний
Тема: документация
35 материалов в этой теме.
Материалы
12 на странице
Статья
Ясность: предложения, термины, двусмысленности
Как устроена ясная фраза в инженерном документе: деятель и действие, известное в начале и новое в конце, каталог двусмысленностей, термины как контракт, модальность …
Статья
Что делать с найденным: воспроизводимый след
Разведка, после которой ничего не осталось, будет повторена целиком. Разбираем пять форм следа от исполняемого теста до личной заметки, анатомию записи из семи полей, …
Статья
Чтение технических текстов: документация, статьи, книги
Разные жанры технических текстов требуют разных режимов чтения: что известно про физиологию чтения и скорочтение, какие приёмы работы с текстом имеют доказательную базу, …
Статья
Чтение документации: как устроен технический английский
Почему документацию на английском можно читать быстро даже со средним языком: жанры страниц и их грамматика, цепочки существительных, модальные глаголы, артикли со …
Статья
Читатель и решение: зачем существует этот документ
Технический документ существует ради решения, которое должен принять конкретный читатель: как найти адресата, сформулировать запрос на решение, переписать абзац под него, …
Статья
Устав, содержание и WBS: три базовых документа проекта и контроль изменений
Устав как зафиксированное решение и адрес ответственности, описание содержания с самым ценным разделом «вне объёма», WBS по правилу 100% и правилу 8/80, матрица …
Статья
Техническое письмо: карта трека и зачем инженеру писать
Почему инженерный документ существует только ради решения, которое он должен изменить, и читателя, который это решение примет; какие жанры бывают, почему документация …
Статья
Тестирование и документация: тесты, doc-тесты, бенчмарки, property-based
Как устроен cargo test изнутри, чем unit-тесты отличаются от интеграционных, почему doc-тесты в Rust — часть контракта, и как property-based, фаззинг, Miri, loom и …
Статья
Тестирование в Elixir: ExUnit, async, doctests, Mox и property-based со StreamData
ExUnit и асинхронные тесты, doctests из документации, моки через Mox и поведения, property-based тестирование со StreamData, покрытие, тест-пирамида и интеграция в CI.
Статья
Тест-кейсы, чек-листы, тест-план и как писать баг-репорт, который починят
Практическое руководство по тестовой документации: когда нужен чек-лист, а когда тест-кейс, как устроен живой тест-план, и как написать баг-репорт, который разработчик …
Статья
Схемы в документах: когда рисовать и что именно
Схема — такое же утверждение с адресатом и решением, как абзац: она отвечает на один вопрос одного читателя или не нужна вовсе. Что глаз читает лучше текста, а что хуже; …
По этому запросу ничего не найдено.