Blueprint-Dokumentreferenz
Verwenden Sie diese Fähigkeit beim Erstellen oder Bearbeiten von Blueprint-Dokumenten in diesem Repository. Blueprints sind wiederholbare Implementierungen, die etablierte Geschäftsprobleme beheben und Architekturdiagramme, technische Überlegungen und Links zur Adobe Experience League-Dokumentation enthalten.
Anwendungszeitpunkt
- •Erstellen eines neuen Blueprint-Dokuments oder einer neuen Blueprint-Übersichtsseite
- •Hinzufügen oder Neustrukturieren von Abschnitten in einem vorhandenen Blueprint
- •Verknüpfen mit oder Zitat aus der Adobe Experience League-Dokumentation
- •Ausrichten neuer Inhalte mit Blueprint-Konventionen (Schriftarten, Überschriften, Diagramme)
Kurzübersicht
- •Dokumentzweck: Blueprints bieten eine System- und Datenflussarchitektur, die zeigt, wie Adobe Experience Platform und Programme integriert sind. Sie sind visuell und technisch, nicht im Marketing.
- •Abschnitte: Verwenden Sie die Standardabschnitte aus der Vorlage; lassen Sie nur weg, wenn sie nicht anwendbar sind (siehe reference.md).
- •Experience League: Verknüpfen Sie Produktdokumente, APIs, Leitplanken und Tutorials lieber mit Experience League. Verwenden Sie vollständige URLs; siehe reference.md für URL-Muster und -Formatierungen.
- •Repo-Struktur: Blueprints live unter
help/blueprints/.help/blueprints/TOC.mdbeim Hinzufügen oder Verschieben von Blueprint-Seiten aktualisieren.
Dokumentvorlage
Jede Blueprint-Seite sollte dieser Struktur folgen. Nur zutreffende Abschnitte einschließen.
--- title: [Short descriptive title] description: "[One sentence: what this blueprint shows and why it matters.]" solution: [Product name, e.g. Real-Time Customer Data Platform, Journey Optimizer] exl-id: [UUID - leave blank if new, this will be auto-generated as part of the Experience League publishing flow] --- # [H1 - same as title or expanded] [1–3 paragraphs: what the blueprint covers, key capabilities, and who it’s for.] ## Applications * [Product 1] * [Product 2] ## Use cases * [Use case 1] * [Use case 2] ## Prerequisites [Bullets or short paragraphs: required products, config, or setup.] ## Architecture Diagram <img src="[path to SVG/image]" alt="[Descriptive alt]" style="width:90%; border:1px solid #4a4a4a" class="modal-image" /> ## Guardrails [Link to Experience League guardrails and any blueprint-specific limits.] ## Implementation patterns [Optional: named patterns with bullets.] ## Implementation steps 1. [Step with link to Experience League where relevant] 2. ... ## Implementation considerations [Optional: identity, performance, security, etc.] ## Related documentation [Grouped links to Experience League: product docs, APIs, tutorials.]
Verwenden Sie für Übersichts- oder Hub-Seiten eine kürzere Struktur: Einführung, Anwendungsfälle (oder Registerkarten), Bildarchitektur, Szenario/Mustertabelle, Voraussetzungen, Leitplanken, zugehörige Dokumentation. Beispiele finden Sie in den vorhandenen Übersichten in help/blueprints/ .
Titelei
| Feld | Erforderlich | Hinweise |
|---|---|---|
title | Ja | Kurz; [!DNL Product Name] für Produktnamen nach Adobe-Stil verwenden |
description | Ja | Ein Satz; wird bei Suche und Karten verwendet |
solution | Ja | Primäres Produkt (z. B. Real-Time Customer Data Platform, Journey Optimizer) |
exl-id | Ja | UUID; Leer lassen für neue Seiten |
doc-type | Für Übersichten | overview-page für die wichtigsten Blueprint-Übersichtsseiten verwenden |
kt | optional | ID des Wissensdatenbankartikels, falls verknüpft |
Verweisen auf Adobe Experience League
- •Wann eine Verknüpfung erstellt: Verknüpfung zu Experience League für Produktdokumentation, API-Referenzen, Leitplanken, Tutorials und Konfigurationsschritte. Keine langwierigen Verfahren duplizieren; zusammenfassen und verknüpfen.
- •URL-: Verwenden Sie vollständige URLs. Bevorzugen Sie
https://experienceleague.adobe.com/docs/?lang=de...oderhttps://experienceleague.adobe.com/de/docs/.... Für Entwicklerdokumente isthttps://developer.adobe.com/...ebenfalls gültig. - •Verknüpfungstext: Verwenden Sie einen beschreibenden Text (z. B. "[Schemata erstellen] (url) und nicht „Hier klicken„). Für Produktnamen im Link-Text verwenden Sie gegebenenfalls
[!DNL Product Name]. - •Abschnitt zur zugehörigen Dokumentation: Beenden Sie Blueprints mit dem Abschnitt „Verwandte Dokumentation“, in dem Links nach Kategorie gruppiert sind (z. B. Zielkonfigurationen, SDK-Dokumentation, Profil und Segmentierung, Tutorials).
Ausführliche URL-Muster, Linkgruppierung und Beispiele finden Sie unter reference.md.
Checkliste vor dem Absenden
- • Frontmatter hat
title,description,solution,exl-id - • H1 entspricht dem Titel oder erweitert ihn entsprechend.
- • Architekturdiagramm vorhanden und Alternativtext beschreibend
- • Implementierungsschritte sind mit Experience League verknüpft, in dem Verfahren ausgeführt werden
- • Abschnitt zu Leitplanken verweist auf offizielle Dokumente zu Experience League-Leitplanken
- • Abschnitt Zugehörige Dokumentation enthält relevante Experience League-Links
- • Neue oder verschobene Seiten werden in
help/blueprints/TOC.mdangezeigt
Weitere Ressourcen
- •Vollständige Vorlagen- und Abschnittshinweise: reference.md
- •Bestehende Blueprints:
help/blueprints/(z. B.audience-activation/real-time-lookup.md,customer-journeys/journey-optimizer/journey-optimizer-overview.md) - •Inhaltsverzeichnis und Navigation:
help/blueprints/TOC.md