Dziesięć sekcji z wagami
Instalacja i użycie ważą po 14, opis 12, tytuł i licencja po 10. Brak sekcji wymaganej to błąd, brak opcjonalnej to ostrzeżenie.
Analizator README
Ocena struktury dokumentacji projektu
Dziesięć wykrywanych sekcji, wynik liczony regułami, ten sam za każdym razem.
Narzędzie webowe
Oficjalna strona produktu
Wydawca:
POLPROG
Oficjalna strona produktu
10
Wykrywane sekcje
5
Sekcje wymagane
4
Wykresy w wyniku
2
Tryby wejścia
01 / Analizator README
O produkcie
Wykrywanych jest dziesięć sekcji z wagami: instalacja 14, użycie 14, opis 12, tytuł 10, licencja 10, konfiguracja 8, współtworzenie 8, spis treści 6, odznaki 5 i testy 5. Pięć z nich jest wymaganych, brak pozostałych to ostrzeżenie.
Wynik składa się w 80% z pokrycia sekcji i w 20% z kontroli struktury: obecność przykładów kodu, rozsądna długość, użycie nagłówków, logiczna kolejność poziomów i obecność linków. Zliczane są też statystyki dokumentu: słowa, linie, nagłówki, bloki kodu, linki, obrazy, odznaki i listy.
Czego nie robi: linki są zliczane, ale nigdy odpytywane, więc narzędzie nigdy nie twierdzi, że link działa albo jest martwy. Analizę wykonuje deterministyczny parser na serwerze POLPROG, bez wysyłania treści do zewnętrznych usług.
02 / Kluczowe funkcje
Kluczowe funkcje
Najważniejsze możliwości opisane w praktyczny sposób.
Wykrywanie po nagłówkach i sformułowaniach
Sekcja jest rozpoznawana po nagłówku ATX lub setext oraz po znanych zwrotach, więc Getting started liczy się jako instalacja, a Quickstart jako użycie.
Parser świadomy bloków kodu
Nagłówki wewnątrz ogrodzonych bloków kodu nie są liczone, blok front matter YAML jest pomijany, a niezamknięty blok nadal liczy się jako jeden.
Kontrole struktury osobno od sekcji
Przykłady kodu, długość dokumentu, liczba nagłówków, brak przeskoków poziomów i obecność linków. Razem odpowiadają za 20% wyniku.
Ścieżka nowego czytelnika
Sekcje układane są w kolejności, której potrzebuje ktoś, kto trafia do projektu pierwszy raz, a lejek pokazuje pierwszy krok, którego brakuje.
Dwa tryby wejścia
Wklejony Markdown albo adres repozytorium. Pobranie odbywa się bez uwierzytelnienia, więc repozytorium prywatne trzeba wkleić.
03 / Pobierz
Dostęp do produktu
Prosta droga od oficjalnego źródła do pierwszego udanego użycia.
Wybierz właściwą platformę
Skorzystaj z jednego z oficjalnych odnośników dostępnych dla Twojego urządzenia lub przeglądarki.
Zainstaluj lub otwórz
Postępuj zgodnie z instrukcjami sklepu lub otwórz aplikację internetową. Bez zewnętrznych instalatorów.
Skonfiguruj i zacznij
Sprawdź dostępne opcje, wybierz preferencje i rozpocznij od podstawowego zastosowania.
Oficjalne opcje dostępu
04 / Technologia
Technologia produktu
Przejrzysty opis głównych technologii użytych do budowy i utrzymania produktu.
PHP
JavaScript
05 / Bezpieczeństwo
Prywatność i bezpieczeństwo
Twoje dane pozostają na Twoim urządzeniu. Zawsze.