Аналізатор README BETA
Проаналізуйте свій README на структуру, повноту та найкращі практики. Вставте Markdown або вкажіть репозиторій.
За правилами, відтворювано, локально
Евристики, які можна передбачити
Розділи розпізнаються за заголовками й відомими формулюваннями; бал це фіксоване зважування цих розділів плюс кілька перевірок структури. Посилання рахуються, але ніколи не запитуються, тож цей інструмент ніколи не стверджує, що посилання робоче чи мертве. Ніщо не аналізується стороннім сервісом ШІ, і після побудови звіту жодного вмісту репозиторію не залишається.
FAQ
Моє README добре, але має низький бал. Як так?
Бал винагороджує передбачувану структуру, бо саме нею орієнтується стороння людина. Блискучий документ без заголовка встановлення все одно коштує новачкові часу, і саме це повідомляє відсутній розділ.
Чи перевіряються посилання?
Ні. Вони рахуються, щоб перевірки структури побачили, чи документ узагалі посилається назовні. Нічого не запитується, тож ніщо тут не каже, чи посилання працює або зламане.
Чи надсилається мій код або README до сервісу ШІ?
Ні. Аналіз виконує детермінований парсер на нашому власному сервері. Текст читається, оцінюється і відкидається.
Чи можу я проаналізувати приватний репозиторій?
За URL ні, бо завантаження відбувається без автентифікації. Вставте натомість Markdown: він обробляється точно так само.
Бажаєте якісну документацію та зручність для розробників?
Ми допомагаємо командам створювати зрозумілу документацію та кращі цифрові продукти.




