Великая Единая Теория Документации

ВеликаяЕдинаяТеорияДокументации

A Систематическая основа для создания технической документации.

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


Великая объединенная теория документации

– Дэвид Лэнг


Фреймворк определяет четыре режима документации – учебники , как- к руководствам , техническая справка и объяснение .

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

'overview of the documentation system'

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

Diátaxis обещает создавать документацию и проекты. лучше, и команды, которые с ними работают, более успешны.


При изменении дизайна Документы разработчика Cloudflare , эта структура контента стала нашей северной звездой в информационной архитектуре. Когда мы не были уверены, где должен быть новый контент, мы обращались к фреймворку. Наша документация стала еще яснее, чем когда-либо, как для читателей, так и для участников.

– Адам Шварц ( @ AdamSchwartz )


Легкий и простой в использовании

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

Видео-презентация

Если вы предпочитаете посмотреть видео по этой теме, вот оно (любезно предоставлено PyCon Australia

).

Leave a comment

Your email address will not be published. Required fields are marked *

10 + 3 =