# Effektive Dokumentation für Discourse schreiben

**URL:** <https://meta.discourse.org/t/writing-effective-documentation-for-discourse/309628>\
**Category:** Contributing\
**Tags:** reference\
**Created:** [28. Mai 2024 um 04:24 UTC](https://meta.discourse.org/t/writing-effective-documentation-for-discourse/309628 "2024-05-28T04:24:22Z")\
**Posts on this page:** 1\
**Showing post:** 3

<div class="post-metadata">

**Author:** ![hugh](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/hugh/32/336717_2.png) [@hugh](https://meta.discourse.org/u/hugh)\
**Post date:** [31. Mai 2024 um 01:22 UTC](https://meta.discourse.org/t/writing-effective-documentation-for-discourse/309628/3 "2024-05-31T01:22:02Z")

</div>

> [@mcwumbly](#):
>
> Sollten wir unser Beispiel entsprechend aktualisieren?

Das ist eine gute Beobachtung – ich hatte diese Verbindung nicht hergestellt, aber es ist einfach zu aktualisieren. Jedoch:

> [@mcwumbly](#):
>
> Wenn es nur nach mir ginge, hätte ich gedacht, wir würden uns für die Großschreibung von Sätzen entscheiden

> [@mcwumbly](#):
>
> Ich gehe davon aus, dass ihr gute Gründe habt, die aktuelle Empfehlung zu wählen.

Die Spezifikation für die Großschreibung von Titeln war meine, weil ich finde, dass sie im Allgemeinen sauberer und professioneller aussieht. Ich denke, das ist sehr viel meine subjektive Meinung, denn sowohl [Google](https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings) als auch [Microsoft](https://learn.microsoft.com/en-us/style-guide/capitalization) empfehlen die Großschreibung von Sätzen in Dokumentationstiteln. Andere Websites, die ich gefunden habe, sagen ebenfalls, dass die Großschreibung von Sätzen verwendet werden soll, also werde ich dies rückgängig machen und die Anforderung für die Großschreibung dort aktualisieren.

---

_[View the full topic](https://meta.discourse.org/t/writing-effective-documentation-for-discourse/309628)._
