Диатаксис

Система Диатаксис направлена на решение проблемы структуры в технической документации. Она применяет системный подход к пониманию потребностей пользователей документации в их цикле взаимодействия с продуктом.

Четыре режима документации

Diátaxis
От Древнегреческого δῐᾰ́τᾰξῐς - dia, "через", and taxis, "расположение".

Система определяет четыре грани документации: руководства, инструкции, справочники and объяснения.

Каждый из этих режимов (или типов) отвечает на разные потребности пользователя, служит разным целям и требует разных подходов к созданию.

Техническая документация должна быть структурирована в соответствии с этими четырьмя типами и должна держать их раздельно и обособленно друг от друга.

Другими словами, то, что мы называем документацией — фундаментально не что-то одно, а сразу четыре. Понимание следствий из этого и того, как эти четыре вещи работают, могут помочь улучшить большую часть документации.

Диатаксис способен сделать документацию и проекты лучше, а команды, которые работают с ними, более успешными.

Простая и легкая в освоении

Система проста, легка в понимании и незамысловата в применении. Она не накладывает ограничений в реализации.

Полная и целостная

Диатаксис предоставляет комплексную и практически универсально-применимую схему, которая была проверена на практике в широком диапазоне направлений и применений. Они включают и большие и маленькие, и открытые и закрытые проекты документации.