Stosowanie Diátaxis¶
Strony w tej sekcji dotyczą praktycznego zastosowania Diátaxis.
Diátaxis jest przede wszystkim przeznaczony jako pragmatyczne podejście dla osób pracujących nad dokumentacją. Większość kluczowych zasad niezbędnych do skutecznego zastosowania można zrozumieć intuicyjnie.
Nie czekaj na zrozumienie Diátaxis, zanim zaczniesz go stosować. Nie tylko nie musisz rozumieć wszystkiego, aby z niego korzystać, ale nie zrozumiesz go, dopóki nie zaczniesz używać (to samo w sobie jest zasadą Diátaxis).
Gdy tylko poczujesz, że przyswoiłeś sobie pomysł, który wydaje się wart zastosowania w pracy, spróbuj go zastosować. Wróć tutaj, gdy potrzebujesz większej jasności lub potwierdzenia. Iteruj między pracą a refleksją nad nią.
W tej sekcji¶
W centrum Diátaxis znajdują się cztery różne rodzaje dokumentacji, które identyfikuje. Jeśli spotykasz się z Diátaxis po raz pierwszy, zacznij od tych stron.
Tutoriale - doświadczenia związane z nauką
Przewodniki krok po kroku - ukierunkowane na cel wskazówki
Referencje - techniczny opis o charakterze informacyjnym
Wyjaśnienie - dyskusja ukierunkowana na zrozumienie
Diátaxis określa zasady, które kierują działaniem. Przekładają się one na konkretne sposoby pracy, z implikacjami dla procesu i wykonania dokumentacji. Po pierwszym kroku, narzędzia i metody przedstawione tutaj pomogą usprawnić pracę.