diataxis

Apply the Diátaxis systematic framework to structure and write documentation.

| Action (doing) | Tutorial | How-to guide | | Cognition (thinking) | Explanation | Reference |

Write tutorials as lessons. Take the learner by the hand through a practical experience where they acquire skills by doing.

Структурируйте, классифицируйте и пишите документацию с помощью платформы Diátaxis. Используйте при написании документации, файлов README, руководств, учебных пособий, практических руководств, ссылок на API или организации архитектуры документации. Также используйте, когда вас просят улучшить документацию, реструктурировать документы, решить, какой тип документа писать, или классифицировать существующий контент. Содержит учебные пособия, практические руководства, ссылки и объяснения. Источник: cachemoney/agent-toolkit.