textlint/textlint: Redaktioneller README-Leitfaden

textlint/textlint beschreibt sich im README als „textlint is the pluggable linter for natural language text.". Dieser Text bleibt bei Fakten, die im Repository überprüfbar sind. Sterne, Forks und Badges zeigen Aufmerksamkeit, aber keine Qualität. Unter „textlint" steht: > The pluggable linting tool for natural language.. Das beschreibt den vorgesehenen Umfang, nicht einen Produktionstest.

Der Abschnitt „Features" zeigt, für welches Problem das Projekt gedacht ist: Supports the use of custom formatters and formatter bundles formatter(reporter). Passt dieses Problem nicht zu deinem Fall, ist Popularität kein ausreichender Grund. Namen, Befehle und Komponenten bleiben unverändert, damit Leser die Primärquelle ohne neue Begriffe vergleichen können. Ein weiterer überprüfbarer README-Punkt lautet: To use a rule, install a textlint rule via npm.. Er hilft beim ersten Test, ersetzt aber keinen Test in der vorgesehenen Umgebung.

Die Betriebsweise verteilt sich auf Abschnitte wie „Quick Tour". Die Quelle nennt: For a quick tour of textlint, checkout our Getting Started guide :squirrel:. Fehlende Angaben zu Architektur, Leistung oder Sicherheit werden nicht ergänzt. Vor einem echten Einsatz müssen Repository-Struktur, Konfigurationsdateien und Release-Verlauf geprüft werden.

Beginne die Installation am dokumentierten README-Einstieg. Ein überprüfbarer Befehl ist: $ npm install textlint --save-dev Wenn kein ausführbarer Befehl vorhanden ist, wird hier keiner erfunden. Prüfe den Abschnitt „Website" auf Abhängigkeiten, Standardports und die Einrichtung beim ersten Start.

Der tägliche Betrieb folgt der Projektdokumentation. Im Abschnitt „Installation" steht: You can install the textlint command using npm:. Konfiguration, Umgebungsvariablen, Rechte und Datenpfade werden nur bei klarer Quelle beschrieben. Unklare Defaults gehören in einen isolierten Test mit rücksetzbarer Konfiguration. Dieselbe Quelle nennt außerdem: If you have installed textlint globally you must install each reference rule globally as well..