Free-programming-books: Konsistenz der Auflistungen (Hilfe gesucht)

Erstellt am 21. Okt. 2020  ·  5Kommentare  ·  Quelle: EbookFoundation/free-programming-books

Mit der Flut von Ergänzungen während des Hacktoberfestes werden einige Websites / Herausgeber / Plattformen hinzugefügt, auf denen Links inkonsistent dargestellt werden.
Ein Beispiel sind Bücher von goalkicker.
Die meisten unserer Goalkicker-Angebote sehen folgendermaßen aus:
* [Spring Framework Notes for Professionals](https://books.goalkicker.com/SpringFrameworkBook) - Compiled from StackOverflow documentation
Dies gibt den Lesern eine Vorstellung davon, was sie zu erwarten haben, und bietet eine korrekte Zuordnung. Aber nicht alle unsere Goalkicker-Links sind gleich formatiert.

Ebenso waren Wikibooks-Links inkonsistent - es gibt bereits eine PR, die daran arbeitet, dies zu beheben. # 4230

Unsere Kursliste hat viel Geld gekostet, und die Zuweisung der Plattform war inkonsistent. Es sollte sein:
`* Titel wie von der Ressource angegeben - Instructor / Creator (Plattform)

PRs zur Verbesserung der Konsistenz werden begrüßt.

PR requested discussion help wanted

Alle 5 Kommentare

@eshellman Ich habe auch diese Inkonsistenz bemerkt.

@ SethiPandi was denkst du?

Sie haben vielleicht bemerkt, wie lange alle meine Antworten sind, aber ich war schon immer ein Fan von Ausführlichkeit und Disambiguierung.

Ich finde es immer schön, explizit zu sein, auch für Dinge, auf die ein vernünftiger Benutzer schließen kann, zumal es keine Garantie gibt, dass alle Benutzer vernünftig sind.

Die einzige meiner Meinung nach wohl ableitbare Sache ist HTML, aber selbst dann denke ich, dass es ideal ist, um es zu spezifizieren, obwohl es nicht obligatorisch sein muss. Ich bin mir jedoch nicht sicher, wo YouTube als ableitbar angesehen werden kann.

Das Folgende repräsentiert nur meine persönliche Erfahrung, nicht den durchschnittlichen Benutzer.
Ich sage dies als jemand, der persönlich erwartet hat, dass alle Bücher PDFs sind, bis mir klar wurde, dass es sich bei den meisten tatsächlich überhaupt nicht um PDFs handelt. (Ich lese lieber offline in KOReader .)
Natürlich kenne ich das jetzt, aber nicht als eine Person, die neu im Repository war und mit den Konventionen nicht vertraut war.

Wir können "YouTube" und "Github" aus den Auflistungen streichen. Für Kurse ist der Plattformname nützlicher, da Plattformen vielfältigere Erfahrungen bieten und möglicherweise Registrierungsanforderungen haben.

'HTML' sollte nur angezeigt werden, wenn es das einzige verfügbare Format ist. Oft führt unser Link zu einer Webseite, die Links zu Inhalten verschiedener Typen enthält.

@eshellman okay toll das hört sich gut an

Wir müssen anbieterspezifische Konsistenznotizen erstellen. So...

Please add the "Compiled from StackOverflow documentation" attribution we use for goalkicker books
For youtube, we prefer "playlist" links and the name of the producer/creators

von PRs:
MIT OpenCourseWare # 5087
Wikibooks # 4230
udacity # 3880
Leanpub

War diese Seite hilfreich?
0 / 5 - 0 Bewertungen

Verwandte Themen

eshellman picture eshellman  ·  18Kommentare

Tlalanne picture Tlalanne  ·  4Kommentare

cktang88 picture cktang88  ·  4Kommentare

harrykar picture harrykar  ·  9Kommentare

eshellman picture eshellman  ·  9Kommentare