Informationen zu Themen

Themen werden zum Filtern von Artikeln verwendet und können auf der GitHub Docs-Website durchsucht werden. Bei einigen Layouts (z. B. Startseiten oder Anleitungen) können Benutzer*innen auswählen, welche Artikel angezeigt werden, indem Themen gefiltert werden. Verwenden Sie diese Richtlinien, um auszuwählen, welche Themen der Frontmatter eines Artikels hinzugefügt werden sollen. Weitere Informationen zum Hinzufügen von Themen zu einem Artikel finden Sie unter Themen, und eine Liste aller zulässigen Themen ist unter allowed-topics verfügbar.

Themen für alle Inhaltstypen

• Alle Artikel sollten mindestens ein Thema beinhalten.
• Verwenden Sie Nomen für die Themen.
• Themen helfen dabei, Inhalte sinnvoll zu gruppieren.
  • Verwenden Sie nach Möglichkeit spezifischere Themen, die relevant sind, und nicht nur allgemeine Themen. Beispielsweise sollte REST oder GraphQL statt nur API verwendet werden.
  • Stellen Sie sicher, dass Themen in ähnlichen Artikeln konsistent sind, damit den Personen, die nach einem Thema filtern, alle relevanten Artikel angezeigt werden. Beispielsweise sollten alle Artikel zu CI das CI-Thema sowie spezifischere Themen enthalten.
  • Vermeiden Sie mehrdeutige Themen. Beispielsweise handelt es sich bei Actions um kein nützliches Thema innerhalb des Actions-Produkts, da sich dies auf das Produkt GitHub Actions oder das Produktelement beziehen könnte, das als Aktion bezeichnet wird.
• Themen bieten einen Mehrwert und replizieren nicht den Titel, den Typ oder die Kategorie des Artikels.
  • Beispielsweise bietet Actions innerhalb des Actions-Produkts keinen Mehrwert, da Benutzer*innen in diesem Abschnitt der Dokumentation bereits wissen, dass sie die Actions-Dokumentation lesen.
• Verwenden Sie Fundamentals für Artikel, die sich auf die Kernkonzepte eines Produktbereichs beziehen.
  • Empfohlen wird beispielsweise die Verwendung von Fundamentals in einem Artikel wie „Einführung in GitHub Actions“.
  • Nicht empfohlen wird beispielsweise die Verwendung von Actions in einem Artikel wie „Einführung in GitHub Actions“.
• Allgemein anerkannte Abkürzungen können verwendet werden, aber undeutliche oder mehrdeutige Abkürzungen sollten vermieden werden.
  • Verwenden Sie CI anstelle von Continuous integration.
  • Vermeiden Sie die Verwendung von AS für Advanced Security.
• Verwenden Sie die Kurzformen von GitHub-Produktnamen.
  • Verwenden Sie Actions anstelle von GitHub Actions.

Checkliste für die Themenauswahl

Berücksichtigen Sie diese Fragen, um Themen für einen Artikel auszuwählen. Nicht jeder Artikel umfasst ein Thema für jedes Element in der Checkliste.

• Um welchen Feature- oder Produktbereich handelt es sich?
  • Beispiel Enterprise: Handelt es sich im Artikel um ein ergänzendes Feature? (Es sei denn, der Produktname stimmt mit dem Featurenamen überein.)
  • Ein Beispiel: Dependabot
• Ist das Feature Teil eines eingeschränkten Programms?
  • Ein Beispiel: Advanced Security
• Auf welches Element des Features oder Produkts bezieht sich der Artikel?
  • Ein Beispiel: Organizations
• Wie lautet der allgemeine Zweck des Artikels?
  • Ein Beispiel: Permissions
• Welche Programmiersprachen, Paket-Manager oder Ökosysteme werden im Artikel explizit behandelt? Fügen Sie diese Themen nur hinzu, wenn dies für die Filterung der Dokumentation einen Nutzen hat, nicht nur dann, wenn in einem Artikel unterstützte Sprachen, Paket-Manager oder Ökosysteme aufgeführt werden.
  • Beispiel: Ruby