CONTENT-TEXTE
Einen Entwurf gegen einen Styleguide prüfen
Wenn ein Entwurf einem hauseigenen Styleguide entsprechen muss und Sie die Verstöße aufgelistet und nicht stillschweigend behoben haben wollen.
style-guide-compliance-edit.md
Sie setzen einen hauseigenen Styleguide an einem Entwurf durch. Berichten Sie, bevor Sie korrigieren.
Styleguide:
{{STYLE_GUIDE}}
Entwurf:
{{DRAFT}}
Ausgabe:
1. Verstoßtabelle: Zitierte Stelle | Gebrochene Regel (Regel wörtlich zitieren) | Schweregrad (blockierend, sollte behoben werden, Geschmacksfrage) | Korrekturvorschlag.
2. Unklarheiten: Fälle, die der Styleguide nicht eindeutig abdeckt. Nennen Sie den Fall und die zwei möglichen Lesarten. Entscheiden Sie sich nicht still für eine.
3. Der korrigierte Entwurf mit umgesetzten blockierenden Punkten und Punkten der Kategorie sollte behoben werden. Geschmacksfragen bleiben unangetastet.
Regeln:
- Zitieren Sie nur Regeln, die tatsächlich im eingefügten Styleguide stehen. Wenn Sie etwas stört, das nicht im Guide steht, listen Sie es separat unter Nicht im Styleguide.
- Ändern Sie beim Stilfix nicht die Bedeutung.
- Beheben Sie dasselbe wiederkehrende Problem nicht still; melden Sie es einmal mit Anzahl und wenden Sie die Korrektur dann durchgängig an.
- Erhalten Sie Zitate Dritter exakt, auch wenn sie gegen den Hausstil verstoßen, und vermerken Sie das.
Vor dem Start ausfüllen
Ersetzen Sie jeden Platzhalter durch Ihre eigenen Angaben. Je genauer Sie sind, desto weniger erfindet das Modell.
- {{STYLE_GUIDE}}
- {{DRAFT}}
So wird das Ergebnis besser
-
1
Fügen Sie den Guide selbst ein, statt ihn zu beschreiben; zusammengefasste Regeln werden lax angewendet.
-
2
Die Liste der Unklarheiten ist kostenlose Pflegearbeit für den Styleguide.
-
3
Heben Sie die Verstoßtabelle auf, um den Autor zu schulen, der immer dieselben Fehler macht.