Poradnik CLAUDE.md

Napisz właściwy plik CLAUDE.md

CLAUDE.md to plik, który kształtuje sposób, w jaki Claude rozumie Twój projekt. Dobrze napisany oznacza mniej poprawek, lepszy kod i agentów, którzy faktycznie wiedza, nad czym pracują.

Ten poradnik przeprowadzi Cię przez każdą sekcję pliku CLAUDE.md: od deklaracji stosu technologicznego po wskazówki dla poszczególnych agentów. Postępuj krok po kroku i stwórz własny plik.

Czym jest CLAUDE.md?

CLAUDE.md to plik Markdown umieszczony w katalogu głównym projektu. Gdy Claude Code rozpoczyna sesję, czyta ten plik jako pierwszy. Wszystko w nim staje się częścią kontekstu Claude: Twój stos technologiczny, struktura plików, konwencje zespołu i wszelkie konkretne instrukcje, których ma przestrzegać każdy agent.

Traktuj to jako dokument briefingowy. Bez niego Claude musi zgadywać, jak zorganizowany jest Twój projekt. Z dobrym plikiem CLAUDE.md Claude już wie, gdzie co się znajduje, jakich wzorców używać i czego unikać. Różnica w jakości wyników jest znacząca.

“10 minut pracy nad CLAUDE.md oszczędza godziny poprawiania kodu wygenerowanego przez AI, który nie pasuje do wzorców Twojego projektu.”

Na podstawie obserwacji setek projektów Claude Code

Słaby vs. dobry CLAUDE.md

Struktura i dokładność pliku CLAUDE.md bezpośrednio wpływają na jakość pracy Claude w Twojej bazie kodu.

Słaby CLAUDE.md

  • ✗Ogólnikowe instrukcje typu "stosuj najlepsze praktyki" bez konkretów
  • ✗Brak mapy plików, więc Claude zgaduje, gdzie umieścić nowy kod
  • ✗Brak konwencji kodowania; styl wyników zmienia się między sesjami
  • ✗Brak komend do budowania i testowania, co prowadzi do błędnych sugestii

Dobry CLAUDE.md

  • ✓Jawnie podany stos z wersjami: React 19, Vite 6, Zustand 5, Tailwind 4
  • ✓Czytelna mapa plików z kluczowymi katalogami i ich przeznaczeniem
  • ✓Udokumentowane konwencje nazewnictwa, obsługa błędów i preferencje stylu
  • ✓Komendy build, test i dev gotowe do skopiowania i uruchomienia

6 kluczowych sekcji

Dobrze skonstruowany plik CLAUDE.md obejmuje te sześć obszarów. Każdy dostarcza Claude konkretnych informacji, z którymi może natychmiast pracować.

Deklaracja stosu technologicznego

Wymień jawnie swoje frameworki, biblioteki i ich wersje. Podaj menedżera pakietów, wersję Node i wszelkie wymagania środowiska uruchomieniowego. Claude używa tego do generowania kompatybilnego kodu bez zgadywania.

Mapa struktury plików

Opisz kluczowe katalogi i co się w każdym znajduje. Komponenty, store, serwisy, trasy API, typy. Krótki diagram drzewa z jednoliniowym opisem każdego folderu sprawdza się dobrze.

Konwencje kodowania

Udokumentuj konwencje nazewnictwa (camelCase dla plików, PascalCase dla komponentów), podejście do obsługi błędów, kolejność importów i wszelkie reguły specyficzne dla projektu. Dzięki temu wyniki Claude pozostają spójne z istniejącym kodem.

Komendy budowania i testowania

Dołącz komendy dev, build, test i lint. Gdy Claude musi coś zweryfikować lub zaproponować skrypt, użyje dokładnie tych komend, których oczekuje Twój projekt.

Wskazówki dla ról agentów

Jeśli używasz wielu agentów (QA, Frontend, Backend, DevOps), dodaj sekcję opisującą, na czym powinna skupić się każda rola. Jest to szczególnie przydatne przy konfiguracji wieloagentowej AgentsRoom.

Obszary do unikania

Powiedz Claude, czego NIE robić. Nie modyfikować plików konfiguracyjnych, nie zmieniać systemu autoryzacji, nie refaktoryzować warstwy bazy danych. Jawne granice zapobiegają niepożądanym zmianom ze strony agentów.

Stwórz CLAUDE.md w 4 krokach

Nie musisz pisać wszystkiego naraz. Zacznij od podstaw i rozszerzaj w miarę odkrywania, co Claude musi wiedzieć.

1

Przeanalizuj projekt

Otwórz package.json i wymień każdy framework, bibliotekę i narzędzie używane w projekcie. Zapisz wersje. Sprawdź wymagania środowiska (wersja Node, wersja Python, baza danych). Z tego powstanie sekcja stosu technologicznego.

package.json + wersje środowiska + baza danych

2

Zmapuj drzewo plików

Zrób szybki przegląd drzewa katalogu src. Zidentyfikuj foldery najwyższego poziomu i napisz jednoliniowy opis każdego z nich. Skup się na lokalizacji komponentów, store, serwisów, typów i tras API.

Drzewo src/ z opisami przeznaczenia

3

Udokumentuj konwencje

Przejrzyj istniejący kod i zanotuj wzorce: jak nazywasz pliki, jak obsługujesz błędy, jak strukturyzujesz importy, czy używasz default czy named exports. Zapisz je jako krótkie reguły.

Nazewnictwo, importy, obsługa błędów, eksporty

4

Dodaj sekcje dla agentów

Jeśli pracujesz ze specjalistycznymi agentami, dodaj obszary fokusa dla każdej roli. Agent Frontend powinien znać Twoją bibliotekę komponentów. Agent DevOps powinien znać pipeline wdrożeń. Agent QA powinien znać framework testowy.

Obszary fokusa i unikania dla każdej roli

Dlaczego AgentsRoom dla CLAUDE.md?

AgentsRoom został zbudowany z CLAUDE.md jako centralnym elementem, nie dodatkiem.

Wbudowany edytor CLAUDE.md

Edytuj CLAUDE.md bezpośrednio w AgentsRoom z podświetlaniem składni i automatycznym zapisem. Bez przełączania do edytora tekstu czy IDE.

Podgląd na żywo dla każdego agenta

Obserwuj w czasie rzeczywistym, jak każdy agent interpretuje Twój CLAUDE.md. Śledź wyjście terminala, aby upewnić się, że agenci przestrzegają konwencji i respektują obszary do unikania.

Kontekst na projekt

Każdy projekt w AgentsRoom ma własny plik CLAUDE.md. Przełączaj się między projektami, a każdy agent automatycznie załaduje odpowiedni plik kontekstowy dla danej bazy kodu.

Integracja ról agentów

14 ról agentów w AgentsRoom jest bezpośrednio powiązanych z sekcjami CLAUDE.md. Zdefiniuj obszary fokusa i unikania dla każdej roli, a każdy agent pobierze dokładnie te instrukcje, które są dla niego przeznaczone.

Watch what your CLAUDE.md does to Claude Code token usage

CLAUDE.md is prepended to every Claude turn. A bloated CLAUDE.md silently inflates Claude Code token usage on every message. AgentsRoom puts a per-session token meter on each agent so you can see exactly how much your CLAUDE.md is costing you, with a live cache hit rate to confirm it stays cached.

See the Claude Code token usage tracker

FAQ dotyczący CLAUDE.md

Gdzie umieścić plik CLAUDE.md?+
Umieść go w katalogu głównym projektu, obok package.json lub odpowiedniego pliku konfiguracyjnego. Claude Code odczytuje go automatycznie przy rozpoczęciu sesji w tym katalogu. Możesz też tworzyć zagnieżdżone pliki CLAUDE.md w podkatalogach dla bardziej szczegółowego kontekstu.
Jaka powinna być długość pliku CLAUDE.md?+
Nie ma ścisłego limitu, ale celuj w 50 do 300 linii. Obejmij podstawy: stos technologiczny, strukturę plików, konwencje i komendy. Zbyt krótki plik oznacza brak kontekstu dla Claude. Zbyt długi ryzykuje rozmycie ważnych części niepotrzebnym szumem.
Czy CLAUDE.md działa ze wszystkimi modelami Claude?+
Tak. CLAUDE.md jest odczytywany przez Claude Code niezależnie od wybranego modelu (Opus, Sonnet lub Haiku). Wszystkie modele korzystają z jawnego kontekstu projektu, choć większe modele jak Opus mogą przyswajać i stosować bardziej szczegółowe instrukcje.
Czy powinienem dodać CLAUDE.md do kontroli wersji?+
Tak, jeśli chodzi o wspólne instrukcje projektu. Twój zespół skorzysta na spójnym zachowaniu AI u wszystkich deweloperów. Dla osobistych preferencji AgentsRoom obsługuje prywatne konfigurację agentów, które są automatycznie dodawane do gitignore.
Czy mogę używać CLAUDE.md z wieloma agentami?+
Oczywiście. W AgentsRoom każdy agent w projekcie czyta ten sam CLAUDE.md. Możesz dodać sekcje specyficzne dla ról (np. notatki dla agenta QA w odróżnieniu od agenta Frontend), aby każdy specjalista otrzymał ukierunkowane instrukcje.
Jak często aktualizować CLAUDE.md?+
Aktualizuj go przy każdej zmianie struktury lub konwencji projektu. Dodałeś nowy framework? Zaktualizuj stos technologiczny. Zmieniłeś układ katalogów? Zaktualizuj mapę plików. Nieaktualny CLAUDE.md prowadzi do nieaktualnych sugestii.

Warto przeczytać

Zacznij pisać lepsze pliki CLAUDE.md

Pobierz AgentsRoom i użyj wbudowanego edytora CLAUDE.md, aby dać agentom potrzebny kontekst. Lepsze instrukcje, lepszy kod.

Za darmoPobierz AgentsRoom

Aplikacja towarzysząca: monitoruj agentów w podróży

Użyj Claude, Codex, Antigravity CLI lub innego dostawcy AI.

Zainstaluj rozszerzenie
Chrome Web Store

Wysyłaj bugi i prośby bezpośrednio do swojego publicznego backlogu.

Wiele projektów
Multi-provider
Wielu agentów
Status na żywo
Diff i commit
Aplikacja mobilna
Podgląd na żywo
Zespoły agentów
Testy w przeglądarce
Dev oparta na backlogu
Biblioteka promptów
Biblioteka umiejętności
Zobacz wszystkie funkcje