Informationen zu Diagrammen in GitHub Docs
Diagramme verwenden Formen, Linien und Beschriftungen, um Konzepte visuell zu erläutern. Wir verwenden Diagramme zur Unterstützung von Textinformationen in GitHub Docs.
Diagramme machen Informationen nicht weniger komplex, stellen aber eine andere Möglichkeit zum Empfangen und Verarbeiten von Informationen dar. Einige Personen möchten Informationen bildlich dargestellt bekommen, anstatt sie lesen zu müssen. Einige Personen können mit visuellen Diagrammen nichts anfangen und benötigen die Darstellung der Informationen in Form von Text.
Es gibt viele Verwendungen für Diagramme. Diagramme können allgemeine Übersichten über Konzepte bereitstellen, für die sonst Absätze oder ganze Artikel geschrieben werden müssten. Jemand kann sich das Diagramm anzeigen lassen und dann entscheiden, ob er weitere Informationen lesen möchte. Diagramme können auch für die Entscheidungsfindung auf Systemebene verwendet werden, indem sie helfen, einen gesamten Prozess auf einmal oder auf Mikroebene, bestimmte Schritte in einem Workflow zu verstehen. Diagramme sind Inhalte und wie alle Inhalte müssen sie mit Sorgfalt behandelt werden, um zu bestimmen, wie sie am besten verwendet werden können.
Diagramme sind kreativ. Wenn Sie eine Idee für ein Diagramm haben, das Personen hilft, unabhängig von den genauen Formen, die es verwendet, ist es möglicherweise gut für GitHub Docs geeignet. Die folgenden Anforderungen und Empfehlungen helfen Ihnen beim Erstellen eines Diagramms, das in GitHub Docs enthalten sein kann.
Diagrammprüfliste
Um in GitHub Docs enthalten zu sein, muss ein Diagramm die folgenden Kriterien erfüllen.
- Auf das Diagramm kann von so vielen Benutzern wie möglich zugegriffen werden.
- Diagramme weisen klare Startpunkte auf und es ist leicht, ihnen zu folgen.
- Diagramme stehen vor oder folgen abgeschlossenen Textbeschreibungen im Artikel, in dem sie angezeigt werden, ohne dass Informationen vollständig in visueller Form vermittelt werden.
- Diagramme weisen einen geeigneten Kontrast auf.
- Diagramme weisen einen geeigneten Alternativtext auf.
- Diagramme sollen klar und deutlich und die einzelnen Elemente so gut wie möglich lesbar sein.
- Das Diagramm weist Akzeptanzkriterien auf und erfüllt diese.
- Diagramme haben eine Zielgruppe.
- Diagramme weisen die richtige Menge an Informationen und Dichte auf.
- Das Diagramm spricht visuell an.
- Die Diagramme folgen dem in diesem Inhaltsmodell festgelegten Stil.
- Diagramme enthalten genügend Informationen, um leicht verständlich und übersichtlich zu sein, sind verfügen über keinen übermäßigen Decor oder sind nicht unnötig komplex.
Verwalten von Diagrammen
Der Creator eines Diagramms ist auch seine Verwaltung zuständig. Wenn ein Diagramm nicht mehr aktuell ist, liegt es im Ermessen des GitHub Docs-Teams, das Diagramm zu entfernen, zu aktualisieren oder zu ersetzen.