README Analyzer - notez le README de votre projet | POLPROG Skip to content

Analyseur de README BETA

Analysez la structure, l'exhaustivité et les bonnes pratiques de votre README. Collez du Markdown ou indiquez-nous un dépôt.

Gratuit Sans inscription Respect de la vie privée
Collez le Markdown de votre README ou indiquez-nous un dépôt GitHub.
Portée et limites

À base de règles, reproductible, local

Des heuristiques prévisibles

Les sections sont détectées à partir des titres et de formulations connues ; le score est une pondération fixe de ces sections plus quelques contrôles de structure. Les liens sont comptés, jamais appelés : cet outil n'affirme donc jamais qu'un lien est mort ou vivant. Rien n'est analysé par un service d'IA tiers, et aucun contenu de dépôt n'est conservé après le rapport.

Aide

FAQ

Mon README est bon mais son score est bas. Comment ?

Le score récompense une structure prévisible, car c'est ce qui guide un inconnu. Un document brillant sans titre d'installation coûte quand même du temps à un débutant, et c'est ce que signale la section manquante.

Les liens sont-ils vérifiés ?

Non. Ils sont comptés pour que les contrôles de structure voient si le document renvoie vers l'extérieur. Rien n'est appelé, donc rien ici ne dit qu'un lien fonctionne ou non.

Mon code ou mon README part-il vers un service d'IA ?

Non. L'analyse est un analyseur déterministe sur notre propre serveur. Le texte est lu, noté, puis abandonné.

Puis-je analyser un dépôt privé ?

Pas par URL, car la récupération se fait sans authentification. Collez plutôt le Markdown : il est traité exactement de la même façon.

Envie d'une documentation soignée et d'une bonne expérience développeur ?

Nous aidons les équipes à livrer une documentation claire et de meilleurs produits numériques.

Nous contacter