README Analyzer - ohodnoťte README svojho projektu | POLPROG Skip to content

Analyzátor README BETA

Analyzujte svoj README z hľadiska štruktúry, úplnosti a osvedčených postupov. Vložte Markdown alebo nám zadajte repozitár.

Zadarmo Bez registrácie Súkromie na prvom mieste
Vložte Markdown svojho README alebo nám zadajte GitHub repozitár.
Rozsah a hranice

Podľa pravidiel, opakovateľne, lokálne

Heuristiky, ktoré sa dajú predvídať

Sekcie sa rozpoznávajú z nadpisov a známych formulácií; skóre je pevné váženie týchto sekcií plus niekoľko kontrol štruktúry. Odkazy sa počítajú, nikdy nevolajú, tento nástroj teda nikdy netvrdí, že odkaz funguje alebo je mŕtvy. Nič neanalyzuje cudzia AI služba a po zostavení reportu nezostáva žiadny obsah repozitára.

Pomoc

FAQ

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

Skóre odmeňuje predvídateľnú štruktúru, lebo podľa nej sa orientuje cudzí človek. Skvelý dokument bez nadpisu inštalácie aj tak stojí nováčika čas, a presne to hlási chýbajúca sekcia.

Kontrolujú sa odkazy?

Nie. Počítajú sa, aby kontroly štruktúry videli, či dokument vôbec odkazuje von. Nič sa nevolá, nič tu teda nehovorí, že odkaz funguje alebo je pokazený.

Posiela sa môj kód alebo README do AI služby?

Nie. Analýzu robí deterministický parser na našom vlastnom serveri. Text sa prečíta, ohodnotí a zahodí.

Môžem analyzovať súkromný repozitár?

Cez URL nie, lebo sťahovanie prebieha bez overenia. Vložte namiesto toho Markdown: spracuje sa úplne rovnako.

Chcete vyladenú dokumentáciu a lepší zážitok pre vývojárov?

Pomáhame tímom dodávať prehľadnú dokumentáciu a lepšie digitálne produkty.

Kontaktujte nás