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.

Struttura, classifica e scrivi documentazione utilizzando il framework Diátaxis. Da utilizzare durante la scrittura di documenti, file README, guide, tutorial, guide pratiche, riferimenti API o l'organizzazione dell'architettura della documentazione. Utilizzalo anche quando ti viene chiesto di migliorare la documentazione, ristrutturare i documenti, decidere quale tipo di documento scrivere o classificare il contenuto esistente. Copre tutorial, guide pratiche, riferimenti e spiegazioni. Fonte: cachemoney/agent-toolkit.