О разделе
Техническое письмо
Техническое письмо - это когда мы объясняем сложную штуку (кнопки, код, болты, законы) так, чтобы другой человек понял её с первого раза и не накосячил.
Документация
Документация — это совокупность документов, созданных для описания, объяснения, сопровождения или управления продуктом, системой, процессом или проектом. Её целью является обеспечение понимания,…
Виды документации
В традиционной инженерной практике (особенно в машиностроении, энергетике, оборонке) эксплуатационная документация — это часть конструкторской документации, регламентированная стандартами, такими как…
Технический писатель
В крупных корпорациях и регулируемых отраслях (финансы, здравоохранение, энергетика) документация — это требование compliance. Аудиторы, регуляторы, внутренние контролёры требуют полной…
Качество документации
Хорошая документация — это та, которую не нужно объяснять устно. Если команда постоянно уточняет — А в документе это имеется в виду так-то? — значит, документация недостаточно ясна.
Архитектура документации
Архитектура документации — это целенаправленное проектирование структуры, содержания, форматов, потоков и взаимосвязей всех документов, сопровождающих продукт или систему на всех этапах её жизненного…
Экосистема технического письма
Markdown Extra — используется в некоторых генераторах (например, в MkDocs) для расширенных возможностей.
Стилевые паттерны технической документации
Паттерны стиля возникают как реакция на хаос. В отсутствие общих ориентиров коммуникация распадается — одни разработчики пишут код с магическими числами и без комментариев, другие — с избыточной…
Техническое задание по ГОСТ
Техническое задание (ТЗ) — это документ, в котором заказчик и исполнитель договорились о правилах игры до того, как кто-то начал что-то делать.
Спецификация по ГОСТ
Спецификация - это список всех деталей и инструкций к ним, которые входят в поставку программы. Опись того, за что платят и что получают.
ПМИ по ГОСТ
ПМИ - это документ, в котором написано, как будут проверять, работает ли программа так, как надо.
ПЗ по ГОСТ
📌 Если используется open-source компонент — указать — название, версия, - лицензия (MIT, Apache 2.0, GPL-3 и т.п.), - источник (GitHub URL, релиз).
Руководство системного программиста по ГОСТ
Руководство системного программиста — это инструкция для того, кто ставит и настраивает программу на сервере.
Руководство программиста по ГОСТ
✅ Рекомендация — оформлять в виде таблиц. ❌ Ошибка — смешивать требования к системе и требования к разработке (например, требуется опыт в Spring Безопасность — это требование к персоналу).
Руководство оператора по ГОСТ
Руководство оператора - это документ о том, как выполнять конкретные операции — пошагово, с картинками интерфейса. Чтобы создать заявку — (1) нажмите кнопку Новая заявка, (2) заполните поле Клиент,…
Руководство по техническому обслуживанию по ГОСТ
Руководство по техническому обслуживанию - это регламентные процедуры — (1) как сделать резервную копию данных, (2) как обновить программу без потери конфигурации, (3) как проверить целостность…
Руководство пользователя по ГОСТ
Стандарт введён в действие с 30 апреля 2022 г. и распространяется на АС всех видов деятельности — научные исследования (НИР), управление (АСУ), проектирование (САПР), производство (АСУ ТП)
Руководство администратора по ГОСТ
❗ Не указывайте любой современный браузер — это ошибка. Укажите конкретные версии и режимы (Chrome ≥115, без блокировки third-party cookies).
Документирование API с использованием Swagger/OpenAPI
В мире gRPC, где используется бинарный протокол и строгая типизация через Protocol Buffers, документирование происходит на уровне .proto-файлов. Эти файлы содержат описание сервисов, методов,…
Итоги
Итоги раздела Техническое письмо — вопросы для самопроверки в энциклопедии Вселенная IT.
Чек-лист самопроверки
Итоги и вопросы по теме Чек-лист самопроверки для самопроверки в энциклопедии Вселенная IT.
Техническое письмо — о разделе
Подборка материалов раздела Техническое письмо в энциклопедии Вселенная IT