docs(readme): slowa, ktorych szuka publicznosc, tam gdzie i tak pasuja - #272
Merged
Merged
Conversation
… fit GitHub's own search indexes the README, and it is the largest document this repository has. Measured today: "scan to email" appeared zero times, "MFP" zero, "gateway" zero. We sat at position 94 for "scan to email" and outside the top hundred for "smtp gateway" - both terms the people this project is written for actually type. Two rows rewritten, and only where the words were already the right ones. Row two covers a compatibility list for printers, MFPs, scanners and NAS units, which is what it is; row three describes scan-to-email setup by brand, which is what that page does. Nothing was added that the sentence did not already mean. Row two also now names the published dataset URL. That was added today and the README, which is where most people arrive, said nothing about it. Worth being explicit about the line this is on. GitHub search ranks partly on text we control, so writing the reader's vocabulary into a sentence that was going to exist anyway is fair. Adding a keyword the sentence does not need would be the other thing, and it would also read badly to the human who gets here - which is the only reader that eventually matters.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Wyszukiwarka GitHuba indeksuje README, a to największy dokument tego repozytorium.
Zmierzone dzisiaj:
scan to emailMFPgatewayTo są frazy, które realnie wpisują ludzie, dla których ten projekt powstał.
Dwa wiersze przepisane — i tylko tam, gdzie te słowa już były właściwe
Wiersz drugi opisuje listę kompatybilności drukarek, MFP, skanerów i NAS-ów — bo tym jest. Wiersz trzeci opisuje konfigurację scan to email po markach — bo to robi tamta strona.
Nie dodałem nic, czego zdanie już by nie znaczyło.
Wiersz drugi wymienia teraz też adres opublikowanego zbioru danych. Dodaliśmy go dzisiaj, a README — czyli miejsce, do którego trafia większość — nie mówiło o nim nic.
Gdzie przebiega granica
Wyszukiwarka GitHuba rankuje częściowo po tekście, który kontrolujemy, więc wpisanie słownika czytelnika w zdanie, które i tak miało powstać, jest uczciwe.
Dodanie słowa kluczowego, którego zdanie nie potrzebuje, byłoby czymś innym — i czytałoby się źle człowiekowi, który tu trafi. A to jedyny czytelnik, który ostatecznie się liczy.