ark-documentation

Guidance for structuring Ark documentation using the Diataxis framework. Use this skill when creating new docs, deciding where content belongs, reviewing documentation PRs, or restructuring existing documentation.

1. Załaduj umiejętność w swoim agencie Claude lub Copilot, wskazując repozytorium McKinsey Ark z folderu .claude/skills/documentation.

2. Kiedy tworzysz nową dokumentację lub przeglądzasz istniejącą, opisz kontekst: czy piszesz tutorial dla początkujących, poradnik zadaniowy dla doświadczonych użytkowników, czy materiał referencyjny. Umiejętność podpowie, do której kategorii Diataxis powinna należeć treść.

3. Korzystaj z umiejętności podczas recenzji pull requestów dokumentacji – przekaż jej fragment tekstu, a ona wskaże, czy struktura i styl odpowiadają założeniom danego typu dokumentacji (np. czy tutorial ma liniową ścieżkę, czy poradnik jest zorientowany na konkretne zadanie).

4. Jeśli reorganizujesz istniejącą dokumentację, użyj umiejętności do mapowania treści na strukturę Diataxis: Introduction, Quickstart, Tutorials, How-to Guides, Core Concepts, Reference i Marketplace.

5. Zwróć uwagę na persona-based organization w How-to Guides – umiejętność pomoże Ci sklasyfikować treść dla deweloperów aplikacji (Build with ARK), współtwórców (Extend ARK) lub operatorów (Operate ARK).

6. Przejrzyj wytyczne dotyczące stylu pisania dla każdego typu: tutoriale używają "my", poradniki są zadaniowe, koncepcje wyjaśniają "dlaczego", a materiały referencyjne zawierają fakty do szybkiego wyszukania.