Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

cmk:codebase-docs

/cmk:codebase-docs

Tworzy i odświeża dokumenty dla AI, które wskazują właściwe pliki kodu bez powielania treści, by ułatwić nawigację po repozytorium.

Repozytorium
ai-devkit ↗
Licencja
MIT
Ostatnia zmiana repozytorium
20.10.2026

Ocena i bezpieczeństwo

85/ 100Klasa: dobry
Format15 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść30 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
7
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 20.10.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Tworzy i odświeża dokumenty dla AI, które wskazują właściwe pliki kodu bez powielania treści, by ułatwić nawigację po repozytorium.

Wyzwalacze z opisu

document the codebase for AIbootstrap AI docsgenerate codebase mapset up AI navigation docsupdate AI docsrefresh docs after changedocument this repo
Oryginalny opis (EN)

Use when the user asks to "document the codebase for AI", "bootstrap AI docs", "generate codebase map", "set up AI navigation docs", "update AI docs", "refresh docs after change", or mentions building progressive-disclosure docs so an AI can find the right source files quickly. Produces a tree of concise docs that *point to* code rather than duplicate it. Use even when the user only says "document this repo" without specifying the structure.

Jak działa

  1. When to use
  2. References
  3. Final check
Sekcje z nagłówków SKILL.md, w oryginale · 28 linii, 223 słów
Podgląd SKILL.md
---
name: cmk:codebase-docs
description: Use when the user asks to "document the codebase for AI", "bootstrap AI docs", "generate codebase map", "set up AI navigation docs", "update AI docs", "refresh docs after change", or mentions building progressive-disclosure docs so an AI can find the right source files quickly. Produces a tree of concise docs that *point to* code rather than duplicate it. Use even when the user only says "document this repo" without specifying the structure.
version: 0.1.3
---

# Codebase Docs for AI Navigation

Build a tree of short documentation files under `docs/ai/` whose only job is to help an AI (or a human skimming quickly) locate the right source file for a topic. Each doc describes **what a thing is and where it lives**, not how the code works line-by-line.

The tree mirrors how a newcomer would ask questions: start broad ("what is this repo?"), then drill down ("how does the TUI input loop work?"). At each level, the reader sees a short menu of sub-topics, each a one-line hook, and only descends into the ones that matter.

## When to use

Two explicit entry points — never run on autopilot:

- **Bootstrap** — user says something like "set up AI docs", "document the codebase for AI", or it's a fresh repo with nothing under `docs/ai/`. Build the whole tree from the top.
- **Update** — user says "update the AI docs for X", "I added feature Y, refresh the docs", or similar. Find the affected nodes and edit in place; don't rewrite everything.

If the mode is ambiguous, ask.

## References

Bootstrap? Read `references/bootstrap-workflow.md`.
Update? Read `references/update-workflow.md`.
Doc shape, principles, split heuristic, and what not to document? Read `references/doc-shape.md`.
Want a concrete sketch? Read `references/working-example.md`.
Failure modes? Read `references/failure-modes.md`.

## Final check

Before finishing, run the checklist in `references/failure-modes.md`.
Pliki w paczce (7)
  • SKILL.md 2 KB
  • eval.json 2 KB
  • references/bootstrap-workflow.md 2 KB
  • references/doc-shape.md 5 KB
  • references/failure-modes.md 1 KB
  • references/update-workflow.md 1 KB
  • references/working-example.md 2 KB

Wersje

W bazie nie ma innych skilli o nazwie cmk:codebase-docs.

Migawka bazy z 13.11.2026 · wersja paczki 26b2474fc240 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 80cmk:docs
    Zakłada i sprawdza strukturę katalogu /docs z nawigacyjnymi plikami README i szablonami dokumentów.
  • 100update-codebase-map
    Odświeża istniejącą mapę kodu i architektury w .claude/.codebase-info po zmianach, gdy dokumenty się zdezaktualizowały.
  • 90cmk:delivery-spec-plan
    Przygotowuje roboczą specyfikację i plan implementacji z zależnościami zadań dla zgłoszenia po wstępnej analizie.
  • 100repo-map
    Tworzy lub odświeża katalogową mapę kodu z opisem każdego katalogu i plików wejściowych, zapisując ją z numerem commita.
  • 100docs-refresh
    Odświeża dokumentację deterministyczną generacją z plików źródłowych, uruchamianą poleceniem /docs-refresh.
  • 90product-context-docs
    Tworzy i aktualizuje dokumentację kontekstu produktu w repozytorium, w katalogu /docs: profil produktu, funkcje, sitemap, architektura i stos technologiczny.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.