Przejdź do treści
Biblioteka skilli
Programowanie · Przegląd i audyt

catalogue-audit

/catalogue-audit

Sprawdza, które repozytoria katalogu nie mają README ani instrukcji, i układa priorytetową listę poprawek bez zapisu w GitHub.

Repozytorium
reposhowcase ↗
Licencja
MIT
Ostatnia zmiana repozytorium
01.11.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 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ść35 / 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
1
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 01.11.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

Sprawdza, które repozytoria katalogu nie mają README ani instrukcji, i układa priorytetową listę poprawek bez zapisu w GitHub.

Wyzwalacze z opisu

which repos need a READMEaudit the docswhat is undocumentedfind repos without instructionsdocumentation reportwhat should I write next
Oryginalny opis (EN)

Reports which catalogue repositories lack a README or usage instructions, in three tiers, and produces a prioritised fix list. Use when the user says "which repos need a README", "audit the docs", "what is undocumented", "find repos without instructions", "documentation report", or "what should I write next". Reads only; never writes to GitHub.

Jak działa

  1. When to use
  2. Inputs
  3. Procedure
  4. Judgement, not just counting
  5. Scripts used
  6. How to tell it worked
Sekcje z nagłówków SKILL.md, w oryginale · 66 linii, 374 słów
Podgląd SKILL.md
---
name: catalogue-audit
description: Reports which catalogue repositories lack a README or usage instructions, in three tiers, and produces a prioritised fix list. Use when the user says "which repos need a README", "audit the docs", "what is undocumented", "find repos without instructions", "documentation report", or "what should I write next". Reads only; never writes to GitHub.
---

# catalogue-audit

How well the catalogue documents itself, and what to fix first.

## When to use

- A periodic review of documentation quality.
- Before publishing, to decide what is worth fixing.
- "Is this repo documented?" — check one name against the report.

## Inputs

Nothing beyond a GitHub token, which the traffic and README API calls need.

## Procedure

1. Run the report:

   ```bash
   python3 scripts/report-readmes.py
   ```

2. Three tiers, because "no README" and "no instructions" are different
   problems:

   | Tier | Means | What to tell the user |
   |---|---|---|
   | `MISSING` | No README file at all | The repository page says nothing |
   | `STUB` | Under 200 bytes — a title, not a description | It looks documented but is not |
   | `NO-USE` | Describes the project, never says how to run it | A reader cannot start |

3. Rank by what a stranger would hit first: file count, then whether the
   repository is the largest in its tier. An 84-file repository with no README
   matters more than a six-file one.
4. Report the ratio as a fraction and a percentage, and say which numbers moved
   since the last run and why. A drop in the missing count caused by
   repositories *leaving* the catalogue is not an improvement — say so.

## Judgement, not just counting

The `NO-USE` detector is a heuristic: a fenced block, an inline code span, a
usage keyword, a shell prompt, an HTTP method, an import, or a tool name. It
produced a false positive once — a Mautic bundle documents usage with a `POST`
example, and the first pattern set had no rule for an inline span or an HTTP
method. If a repository is flagged and you believe it is documented, check the
README yourself before you write anything. The report is evidence, not a
verdict.

## Scripts used

```bash
python3 scripts/report-readmes.py     # writes /tmp/readme_report.json
```

## How to tell it worked

```bash
python3 scripts/report-readmes.py
# missing=N stub=N noUsage=N ok=N, and the four add up to the catalogue size
```

The four counts must sum to the number of repositories in
`src/data/repos.json`. If they do not, a repository was skipped rather than
classified, which is the failure that matters.

Wersje

W bazie nie ma innych skilli o nazwie catalogue-audit.

Migawka bazy z 13.11.2026 · wersja paczki 9084b3844b86 (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

  • 100catalogue-curate
    Decyduje, które repozytoria trafią do katalogu, zapisuje reguły w site.config.json i podaje, co zostało wykluczone i dlaczego.
  • 100catalogue-tag
    Przypisuje repozytoriom katalogu cel, platformę i język z zamkniętej listy i zapisuje je jako tematy GitHub.
  • 100review-docs
    Sprawdza README i pliki instrukcji dla agentów, na przykład CLAUDE.md, pod kątem aktualności względem kodu i kosztu kontekstu.
  • 90profile-glowup
    Poprawia profil GitHub: analizuje repozytoria, pisze README do wybranych projektów i otwiera pull requesty z tymi zmianami.
  • 95readme
    Tworzy lub aktualizuje plik README.md projektu na podstawie jego kodu i dokumentacji.
  • 100readme-writer
    Pisze nowe README lub aktualizuje stare, z instalacją, konfiguracją i użyciem zgodnymi z faktycznym kodem projektu.

Uwagi i zgłoszenia

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