Итоги

НЕ ОБЯЗАТЕЛЬНОДЛЯ НОВИЧКОВ

Руководителю Аналитику Техническому писателю

Основные категории:

первое;
второе;
третье;
четвёртое.

Три основных правила использования:

Первое.
Второе.
Третье.

Три фундаментальных момента:

первый.
второй.
третий.

См. также

Другие статьи этого же раздела в боковом меню (как на странице «О разделе»).

📄️Техническое письмо

Техническое письмо - это когда мы объясняем сложную штуку (кнопки, код, болты, законы) так, чтобы другой человек понял её с первого раза и не накосячил.

📄️Документация

Документация — это совокупность документов, созданных для описания, объяснения, сопровождения или управления продуктом, системой, процессом или проектом. Её целью является обеспечение понимания,…

В традиционной инженерной практике (особенно в машиностроении, энергетике, оборонке) эксплуатационная документация — это часть конструкторской документации, регламентированная стандартами, такими как…

📄️Технический писатель

В крупных корпорациях и регулируемых отраслях (финансы, здравоохранение, энергетика) документация — это требование compliance. Аудиторы, регуляторы, внутренние контролёры требуют полной…

📄️Качество документации

Хорошая документация — это та, которую не нужно объяснять устно. Если команда постоянно уточняет — А в документе это имеется в виду так-то? — значит, документация недостаточно ясна.

📄️Архитектура документации

Архитектура документации — это целенаправленное проектирование структуры, содержания, форматов, потоков и взаимосвязей всех документов, сопровождающих продукт или систему на всех этапах её жизненного…

📄️Экосистема технического письма

Markdown Extra — используется в некоторых генераторах (например, в MkDocs) для расширенных возможностей.

📄️Стилевые паттерны технической документации

Паттерны стиля возникают как реакция на хаос. В отсутствие общих ориентиров коммуникация распадается — одни разработчики пишут код с магическими числами и без комментариев, другие — с избыточной…