README Analyzer - oceń plik README swojego projektu | POLPROG Skip to content

Analizator README BETA

Przeanalizuj plik README pod kątem struktury, kompletności i najlepszych praktyk. Wklej Markdown lub wskaż repozytorium.

Za darmo Bez rejestracji Prywatność przede wszystkim
Wklej Markdown swojego pliku README lub wskaż repozytorium GitHub.
Zakres i ograniczenia

Regułowo, powtarzalnie, lokalnie

Heurystyki, które da się przewidzieć

Sekcje wykrywamy z nagłówków i znanych sformułowań; wynik to stała waga tych sekcji plus kilka testów struktury. Linki są zliczane, nigdy odpytywane, więc to narzędzie nigdy nie twierdzi, że link działa lub jest zepsuty. Nic nie jest analizowane przez zewnętrzną usługę AI, a żadna treść repozytorium nie zostaje po zbudowaniu raportu.

Pomoc

FAQ

Moje README jest dobre, a ma niski wynik. Jak to?

Wynik nagradza przewidywalną strukturę, bo to po niej nawiguje ktoś obcy. Świetny dokument bez nagłówka instalacji i tak kosztuje nowicjusza czas, a to właśnie zgłasza brakująca sekcja.

Czy linki są sprawdzane?

Nie. Są zliczane, żeby testy struktury mogły stwierdzić, czy dokument w ogóle linkuje na zewnątrz. Nic nie jest odpytywane, więc nic tutaj nie mówi, że link działa albo jest zepsuty.

Czy mój kod albo README trafia do usługi AI?

Nie. Analizę wykonuje deterministyczny parser na naszym własnym serwerze. Tekst jest odczytany, oceniony i odrzucony.

Czy mogę przeanalizować prywatne repozytorium?

Nie przez adres URL, bo pobranie jest nieuwierzytelnione. Wklej Markdown: zostanie przetworzony dokładnie tak samo.

Chcesz dopracowaną dokumentację i lepsze doświadczenie deweloperów?

Pomagamy zespołom tworzyć przejrzystą dokumentację i lepsze produkty cyfrowe.

Skontaktuj się