writing-documentation-for-llms
Naucz się pisać dokumentację, którą LLM-y rzeczywiście rozumieją i potrafią wykorzystać.
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność nauczająca, jak tworzyć efektywną dokumentację dla modeli językowych. Dowiesz się, jak zakładać kompetencje LLM-a, ujawniać informacje stopniowo, stawiać przykłady przed wyjaśnieniami i wbudowywać pętle sprzężenia zwrotnego w przepływy pracy. Skup się na tym, co naprawdę potrzebne — każde słowo powinno uzasadniać swój koszt tokenów.
Jak używać
Zainstaluj umiejętność w swoim katalogu Claude, klonując repozytorium lub dodając plik do folderu skills. Upewnij się, że masz dostęp do narzędzi Read, Write i Grep, które są wymagane do pracy z dokumentacją.
Przeczytaj sekcję Core Principles, aby zrozumieć fundamentalne założenia: zakładaj kompetencję LLM-a, eliminuj zbędne wyjaśnienia i testuj instrukcje na różnych modelach (Opus, Sonnet, Haiku mogą wymagać różnego poziomu szczegółowości.
Zastosuj zasadę progressive disclosure — organizuj dokumentację jak spis treści, gdzie główny plik zawiera przegląd i wskazuje na szczegółowe materiały. LLM powinien móc znaleźć potrzebne informacje bez czytania całej zawartości.
Dopasuj specyficzność instrukcji do ryzyka zadania: wąskie, precyzyjne instrukcje dla operacji destrukcyjnych i krytycznych dla spójności, ogólne wytyczne dla zadań wymagających kontekstu (code review, decyzje projektowe).
Priorytetyzuj przykłady nad wyjaśnieniami — zamiast opisywać, jak działa biblioteka, pokaż konkretny kod. Zmniejsza to liczbę tokenów i czyni instrukcje bardziej użytecznym.
Testuj dokumentację na różnych modelach i iteruj na podstawie wyników. Jeśli instrukcja działa dla Claude Opus, ale nie dla Haiku, dodaj więcej kontekstu lub uprość sformułowania.