Понимание Diátaxis¶
Великая объединённая теория документации
—Дэвид Лэйнг
В этом разделе рассматриваются теоретические основания практик, которые предлагает Diátaxis, и некоторые вопросы, возникающие из этого подхода.
Разговор о документации обычно сосредоточен на практических и конкретных вещах. Подход чаще всего эвристический: рекомендации, проверенные правила, прямые предписания и принципы, которые, как известно, работают.
Нам, практикам, есть что сказать о том, что и как делать и как всё это работает, но гораздо меньше — о том, почему оно работает. Представление о правильном подходе во многом складывается из интуиции и опыта. Теории в этой области уделяют значительно меньше внимания.
Цель Diátaxis — подвести под практику создания документации более строгую теоретическую основу.
В этом разделе¶
Эти страницы подробнее раскрывают идеи, лежащие в основе Diátaxis.
Здесь также разбираются типичные проблемы: