Kompas

Mapa Diátaxis jest skutecznym przypomnieniem różnych rodzajów dokumentacji i ich relacji, i dobrze współgra z intuicjami na temat dokumentacji.

Jednak intuicja nie zawsze jest godna zaufania. Często podczas pracy z dokumentacją autor staje przed pytaniem: jaką formę dokumentacji to jest? lub jaką formę dokumentacji potrzebujemy tutaj? - i nie ma oczywistej, intuicyjnej odpowiedzi.

Gorzej, czasami intuicja dostarcza natychmiastową odpowiedź, która jest również błędna.

Mapa jest najpotężniejsza na nieznanym terenie, gdy mamy również kompas, który nas prowadzi.

Kompas Diátaxis jest czymś w rodzaju tabeli prawdy lub drzewa decyzyjnego dokumentacji. Redukuje bardziej złożony, dwuwymiarowy problem do jego prostszych części i dostarcza autorowi narzędzie do korekty kursu.

Jeśli treść…

…i służy użytkownikowi…

…to musi należeć do…

informuje działanie

nabycie umiejętności

tutorial

informuje działanie

zastosowanie umiejętności

przewodnik krok po kroku

informuje poznanie

zastosowanie umiejętności

referencja

informuje poznanie

nabycie umiejętności

wyjaśnienie

Kompas może być stosowany równie dobrze do sytuacji użytkowników, które wymagają dokumentacji, lub do samej dokumentacji, która być może wymaga przeniesienia lub poprawy. Jak wiele dobrych narzędzi, jest zaskakująco banalny.

Aby użyć kompasu, wystarczy zadać dwa pytania: działanie czy poznanie? nabycie czy zastosowanie?

I daje odpowiedź.

Używanie kompasu

Kompas jest szczególnie skuteczny, gdy myślisz, że ty (lub nawet dokumentacja przed tobą) robisz jedną rzecz - ale masz wątpliwości lub napotykasz trudności w pracy. Kompas zmusza cię do zatrzymania się i ponownego rozważenia.

Szczególnie gdy próbujesz znaleźć swoje początkowe orientacje, używaj terminów kompasu elastycznie; nie skupiaj się na dokładnych nazwach.

  • działanie: praktyczne kroki, robienie

  • poznanie: wiedza teoretyczna lub propozycyjna, myślenie

  • nabycie: studiowanie

  • zastosowanie: praca

I same pytania mogą być również używane na różne sposoby:

  • Czy myślę, że piszę dla x czy y?

  • Czy to pisanie przede mną zajmuje się x czy y?

  • Czy użytkownik potrzebuje x czy y?

  • Czy chcę x czy y?

I spróbuj zastosować je z bliska, na poziomie zdań i słów, lub z szerszej perspektywy, rozważając cały dokument.