Referenzinhalte werden für bestimmte Informationen konsultiert. Es sind Informationen, die Sie schnell überprüfen können, was bedeutet, dass es weniger Betonung auf Sätze und Absätze gibt.
Die Referenz enthält Informationen, die in Tabellen, Listen oder anderen strukturierten Formaten am besten dargestellt werden können. Wir können uns referenzieren, da wir unsere automatisch generierten Pipelineinhalte und andere Inhalte einschließen, die potenziell automatisiert werden könnten.
Referenzinhalte werden in Referenzartikeln und Referenzabschnitten in anderen Artikeln angezeigt.
- Einige Hauptthemen erfordern möglicherweise einen eigenen Referenzartikel, insbesondere wenn es eine große Menge an Referenzinhalten gibt, z. B. für suchsyntax oder YAML-Syntax in GitHub Actions.
- Verwenden Sie für kleinere Inhaltsmengen oder spezifischere Informationen, z. B. eine Liste der unterstützten Sprachen oder Hardwareanforderungen eines Features, Referenzabschnitte im Kontext innerhalb von prozeduralen oder konzeptionellen Artikeln.
Anleitung zum Schreiben von Referenzinhalten
Informationen zur Referenzinhaltsvorlage finden Sie unter Vorlagen.
- Schreiben Sie einen Satz oder einen gesamten konzeptionellen Abschnitt, um den Referenzinhalt einzuführen.
- Stellen Sie den tatsächlichen Bezugsinhalt klar und konsistent dar.
- Verwenden Sie für Themen mit einem einzelnen zu erklärenden Element eine Liste.
- Beispiel: Repositoryrollen für eine Organisation
- Verwenden Sie für Themen mit mehreren zu erklärenden Elementen eine Tabelle.
- Beispiel: Repositoryrollen für eine Organisation
- Verwenden Sie Überschriften für umfassendere referenzielle Inhalte (z. B. YAML-Syntax für Workflows) auf konsistente Weise.
- H2-Überschriften für jeden einzelnen Abschnitt
- H3-Überschriften für Unterabschnitte (z. B. Beispiele)
- Beispiel: Workflowsyntax für GitHub Actions
Titel für referenzielle Inhalte
- Referenzartikel oder Überschriften von referenziellen Abschnitten bieten eine klare Beschreibung des Inhalts des Abschnitts und beginnen in der Regel mit Nomen.
- Titel enthalten genügend Informationen, um Anfängern den Inhalt der einzelnen Abschnitte vollständig zu beschreiben.
- Vermeiden Sie bei Titeln Aneinanderreihungen von Nomen. Verwenden Sie Präpositionen, um längere Ketten von Nomen zu unterbrechen.
- Kurze Titel sollten ein Wort oder eine kurze Substantivphrase sein. Beispiel: "AI Models".
Beispiele für Referenzinhalte
- Referenzartikel * Audit-Protokollereignisse für Ihre Organisation * Fähigkeiten von Rollen in einem Unternehmen * REST-API-Endpunkte für die Abrechnung in der REST-API-Dokumentation * Mutationen in der GraphQL-API-Dokumentation
- Referenzabschnitte in anderen Artikeln
- „Unterstützte Sprachen“ in GitHub Mobile
- „Hardwareaspekte“ in Installieren von GitHub Enterprise Server auf AWS