Referenzübersicht

Übersicht

Referenz ist die Heimat einer kompakten, regelorientierten Dokumentation, die nicht in einen Schritt-für-Schritt-Setup-Artikel gehört. Verwenden Sie es für dauerhafte Fakten, Einschränkungen, Terminologie und Produktverhaltenszusammenfassungen, die Benutzer oder Supportteams möglicherweise schnell überprüfen müssen.

Dieser Abschnitt soll kein zweites Leitsystem werden. Leitfäden bleiben von Dokumenten getrennt. Referenzen sollten die Produktdokumentation unterstützen, indem sie das Auffinden wichtiger Fakten erleichtern.

Was in die Referenz gehört

Zu den guten Referenzthemen gehören:

• Workflow-Verhaltensmatrizen
• Plan-, Nutzungs- oder Limitzusammenfassungen
• Kalenderplanungsregeln
• Regeln zur Bestell- und Zahlungsüberprüfung
• Glossarähnliche Produktterminologie, wenn sie sich speziell auf Interlinked-Dokumente bezieht – API- oder Webhook-Referenzen, wenn diese Oberflächen später dokumentiert werden

Referenzseiten sollten sachlich, scanbar und stabil sein. Wenn ein Thema einem Benutzer beibringt, wie man eine Aufgabe erledigt, gehört es wahrscheinlich stattdessen in einen Produktabschnitt.

Wie Reference den LLM-Abruf unterstützt

Referenzseiten sind für Such- und LLM-Exporte nützlich, da sie genaue Regeln an einem Ort konzentrieren. Beispielsweise sind die Fakten in Kalender – wichtige Notizen und Verhaltensweisen einfacher abzurufen, wenn Benutzer oder LLMs eine prägnante Zusammenfassung des Planungsverhaltens benötigen.

Halten Sie beim Hinzufügen neuer Referenzseiten die Titel explizit und vermeiden Sie vage Namen wie „Notizen“ oder „Verschiedenes“. Bevorzugen Sie Titel, die den Produktbereich und die Regelart benennen.

Wartungsanleitung

Referenzseiten sollten überprüft werden, wenn sich das Produktverhalten ändert. Sie fassen oft Regeln zusammen, auf die sich andere Artikel stützen, sodass ungenaue Referenzinhalte zu Verwirrung im gesamten Dokumentensystem führen können.

Verwandte Dokumente

Verwenden Sie diese Seite mit Übersicht über Arbeitsabläufe, Kalender – wichtige Hinweise und Verhaltensweisen und Zahlungsüberprüfung und -sicherheit.