README Analyzer - ohodnoťte README svého projektu | POLPROG Skip to content

Analyzátor README BETA

Analyzujte strukturu, úplnost a osvědčené postupy svého README. Vložte Markdown nebo nám zadejte repozitář.

Zdarma Bez registrace Důraz na soukromí
Vložte Markdown svého README nebo nám zadejte repozitář na GitHubu.
Rozsah a hranice

Podle pravidel, opakovatelně, lokálně

Heuristiky, které lze předvídat

Sekce se rozpoznávají z nadpisů a známých formulací; skóre je pevné vážení těchto sekcí plus několik kontrol struktury. Odkazy se počítají, nikdy nevolají, tento nástroj tedy nikdy netvrdí, že odkaz funguje nebo je mrtvý. Nic neanalyzuje cizí AI služba a po sestavení reportu nezůstává žádný obsah repozitáře.

Nápověda

FAQ

Moje README je dobré, ale má nízké skóre. Jak to?

Skóre odměňuje předvídatelnou strukturu, protože podle ní se orientuje cizí člověk. Skvělý dokument bez nadpisu instalace stejně stojí nováčka čas, a přesně to hlásí chybějící sekce.

Kontrolují se odkazy?

Ne. Počítají se, aby kontroly struktury viděly, zda dokument vůbec odkazuje ven. Nic se nevolá, nic zde tedy neříká, že odkaz funguje nebo je rozbitý.

Posílá se můj kód nebo README do AI služby?

Ne. Analýzu dělá deterministický parser na našem vlastním serveru. Text se přečte, ohodnotí a zahodí.

Můžu analyzovat soukromý repozitář?

Přes URL ne, protože stahování probíhá bez ověření. Vložte místo toho Markdown: zpracuje se úplně stejně.

Chcete vyladěnou dokumentaci a lepší práci pro vývojáře?

Pomáháme týmům dodávat srozumitelnou dokumentaci a lepší digitální produkty.

Kontaktujte nás