Verwenden Sie Abschnitte zur Problembehandlung in Anleitungen oder prozeduralen Artikeln, um Lösungen in der Nähe von Prozeduren bereitzustellen. Arbeite mit Support- und Produktmanagementteams zusammen, um häufige Fehler zu erkennen und in die Dokumentation aufzunehmen.
Bekannte Probleme
Bekannte Probleme stellen einen Teil der Inhalte zur Problembehandlung dar, die speziell für die Reaktion auf Fehler, Probleme im Zusammenhang mit der Nutzung bzw. Benutzeroberfläche sowie andere Produktfehler entwickelt wurden, die eine große Anzahl von Supporttickets verursachen. Während in den Inhalten zur Problembehandlung Fehler beschrieben werden, die auftreten können, handelt es sich bei bekannten Problemen um Szenarios, mit denen Benutzer*innen mit Sicherheit konfrontiert werden.
Wie bei allen Problembehandlungsinhalten können bekannte Probleme einen Abschnitt in einem Artikel oder einen eigenständigen Artikel darstellen. Wenn ein bekanntes Problem auf einen bestimmten Artikel zutrifft, dokumentiere es in diesem Artikel. Wenn ein bekanntes Problem für eine bestimmte Gruppe von Artikeln oder die konzeptionelle Gruppierung von Features gilt oder ein Produkt oder Feature mehrere bekannte Probleme aufweist, die gruppiert werden sollten, erstelle einen dedizierten Artikel vom Typ „Bekannte Probleme mit NAME“.
Inhalte zu bekannten Problemen im Zusammenhang mit einem Produkt oder Feature müssen nicht umfassend sein. Im Gegensatz zu anderen Problembehandlungsinhalten gibt es für einige bekannte Probleme möglicherweise keine Problemumgehungen. Das Ziel der Dokumentation eines Problems ohne Problemumgehung besteht darin, Personen zu helfen, zu bestätigen, dass das Problem vorhanden ist. Auf diese Weise können sie Zeit bei der Suche nach einer Lösung sparen, die noch nicht verfügbar ist, nachdem GitHub bereits festgestellt hat, dass es keine Problemumgehung gibt.
Produkt- und Featurebesitzer*innen (PMs und EMs) sollten beim Planen und Überprüfen von Inhalten zu bekannten Problemen helfen.
Verwenden Sie bekannte Probleme, um die folgenden Situationen zu erläutern.
- Produktverhalten, das den Erwartungen der Benutzer*innen regelmäßig nicht entspricht, aber noch nicht für die Korrektur priorisiert ist
- Verhalten, das die Verwendung des Produkts oder Features für einen gemeinsamen Zweck regelmäßig verhindert
- Seltene oder schwerwiegende Fehler, deren Behebung GitHub noch nicht priorisiert hat und die nicht im Produkt oder durch vorhandene Inhalte auf GitHub Docs erläutert werden
Schreiben von Inhalten zur Problembehandlung
- Verwenden Sie einen beliebigen GitHub Docs-Inhaltstyp, um Abschnitte zur Problembehandlung zu erstellen.
- Sie sollten Inhalte zur Problembehandlung in prozeduralen Inhalten oder Anleitungen nach Möglichkeit beibehalten.
- Sie können einen Artikel zur Problembehandlung erstellen, wenn es sinnvoll ist, diesen Inhalt vom anderen Inhalt zu trennen (z. B. bei umfassenden Inhalten zur Problembehandlung für ein bestimmtes Thema).
- Sie können ein zugehöriges Thema zur Problembehandlung erstellen, wenn viele Artikel zur Problembehandlung für ein Produkt oder Feature vorhanden sind (z. B. Fehlerbehebung bei der SSH).
Titelrichtlinien für Inhalte zur Problembehandlung
- Problembehandlung für FEATURE
- Fehler: FEHLERBEZEICHNUNG
- Bekannte Probleme bei PRODUKT
Beispiele für Inhalte zur Problembehandlung
- Fehlerbehebung bei der SSH
- GitHub Enterprise Server mit einem Load-Balancer verwenden
- Bekannte Probleme in den GitHub Enterprise Server-Versionshinweisen
- Fehler: „We're doing an SSH key audit“ (Es wird ein SSH-Schlüsselaudit durchgeführt)