name: use-case-pattern-page-builder description: 为Adobe Experience Platform Blueprint存储库创建新的用例模式内容指南。 在添加新用例模式、创建实施指导内容或用户提及向Blueprint站点添加模式时,请使用此技能。 处理完整的工作流程:收集模式信息,生成具有正确模板结构的Markdown文件,并更新所有交叉引用页面(TOC.md、overview.md)。 source-git-commit: 349d26f612d4002d1de3d27c7f893bd63ac467a3 workflow-type: tm+mt source-wordcount: '923' ht-degree: 94%
用例模式页面生成器
此技能可指导Adobe Experience Platform Blueprint存储库创建新的用例模式。 它处理整个工作流:从用户那里收集模式信息,生成具有正确模板结构的Markdown内容文件,并更新所有交叉引用页面,以便发现新模式。
开始之前,请阅读以下参考文件,以了解完整的模板结构和要更新的页面核对清单:
references/pattern-template.md— 带占位符值的完整Markdown模板references/pages-to-update.md— 添加模式时必须更新的页面清单
第1阶段:信息收集
在生成任何文件之前询问用户以收集所有必需的信息。 询问以下问题,并且在提供每个项目或明确延迟提供每个项目之前,不要继续生成内容。
所需信息
-
模式名称 — 易于用户识别的标题(例如,“事件触发的消息传递”)。
-
类别 — 刚好是以下之一:
audience-building-activationpersonalizationcampaign-management-orchestrationanalysisconversational-experience
-
主要功能描述 — 描述此模式的用途的单个句子(用于概述表和frontmatter描述)。
-
核心Adobe解决方案 — Adobe产品是此模式的中心。 根据需要从Journey Optimizer、Real-Time Customer Data Platform、Experience Platform、Customer Journey Analytics、Brand Concierge、Journey Optimizer B2B edition、Real-Time CDP B2B edition或其他中进行选择。
-
支持的业务目标 — 来自
/help/blueprints/business-objectives/下的现有集的一个或多个业务目标。 每个名称都应包括目标名称、类别子文件夹和文件名。 在生成内容之前,请验证引用的文件是否存在。 -
战术用例示例 — 6-10个项目符号场景,描述如何在不同业务环境中应用此模式。 每个模板都应该有一个粗体方案名称,后跟一个说明。
-
KPI — 包含三列的表:KPI(名称)、描述(度量值)、度量(公式或方法)。
-
引用链接 — 引用指向主要Experience League文档的链接,这些文档涵盖了用例模式的应用程序和功能。
可选,但推荐
- 用例概述段落(3-5段;如果未提供,则从其他信息中草稿)
- 应用程序列表,其中包含每个Adobe应用程序的角色描述
如果用户不提供可选物料,则根据模式类别、解决方案和执行计划生成合理的默认值。
阶段2:内容生成
在以下路径生成模式Markdown文件:
/help/blueprints/use-case-patterns/{category}/{kebab-case-pattern-name}.md
文件名必须使用从模式名称派生的kebab大小写。 例如,“事件触发的消息传递”变为event-triggered-messaging.md。
使用references/pattern-template.md中的模板并使用收集的信息填写所有占位符值。 生成的文件必须包含模板中的每个部分:
-
YAML frontmatter — title、description、solution(逗号分隔)、exl-id(生成类似
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx的UUID占位符 — 发布团队将分配实际占位符)。 -
打开部分 —
# {Pattern name}标题,后面是介绍性段落和“使用本指南了解……” 句子。 -
用例模式 — 描述段落和执行计划。
-
用例概述 — 3-5个段落,描述模式范围、适用时间、操作和不操作以及典型利益相关者是谁。
-
关键业务目标 — 每个目标都作为链接标题,带有简要说明和KPI摘要行。
-
战术用例示例 — 6-10个方案的项目符号列表。
-
关键绩效指标 — 包含KPI、说明和度量列的表。
-
应用程序 — 具有
[!DNL ...]格式和描述的Adobe应用程序列表。
阶段3:交叉引用更新
生成图案文件后,更新以下文件。 请阅读references/pages-to-update.md以了解详细核对清单。
TOC.md
文件: /help/blueprints/TOC.md
在正确的类别部分下添加新条目。 类别映射到以下目录部分:
| 类别概要 | 目录章节标题 |
| --- | --- |
| audience-building-activation | + Audience Building & Activation{#audience-building-activation} |
| personalization | + Personalization{#personalization-patterns} |
| campaign-management-orchestration | + Campaign Management & Orchestration{#campaign-orchestration-patterns} |
| analysis | + Analysis{#analysis-patterns} |
| conversational-experience | + Conversational Experience{#conversational-experience-patterns} |
条目格式为:
+ [{{Pattern Title}}](/help/blueprints/use-case-patterns/{{category}}/{{filename}}.md)
在匹配部分的最后一个现有条目之后添加新条目。 保留确切的缩进(+前有四个空格)。
“概述”页面
文件: /help/blueprints/use-case-patterns/overview.md
向正确的类别表添加新行。 格式为:
| [{{Pattern Title}}]({{category}}/{{filename}}.md) | {{Primary capability description}} | [!DNL {{Solution1}}], [!DNL {{Solution2}}] |
在匹配类别表中最后一个现有行之后添加新行。
第4阶段:验证
创建并更新所有文件后,请验证以下各项:
-
业务目标链接 — 模式文件中的每个业务目标链接指向
/help/blueprints/business-objectives/下的现有文件。 使用glob或read确认每个目标文件都存在。 -
目录条目位置 — 新的目录条目位于正确的类别部分中,并使用正确的缩进和路径格式。
-
概述表行 — 新的概述行位于正确的类别表中,并且遵循与现有行相同的列格式。
-
文件命名 — 模式文件名使用kebab大小写,并与TOC.md和overview.md中引用的路径匹配。
-
Frontmatter完整性 — 模式文件在其YAML frontmatter中包含标题、描述、解决方案和exl-id。
-
Experience League链接 — 抽查所有Experience League URL是否合理(以
https://experienceleague.adobe.com/zh-hans开头)。
向用户报告任何验证失败,并在考虑任务完成之前修复它们。
注释
- 在表和正文文本中,始终使用用于Adobe产品名称的
[!DNL ...]语法,遵循现有模式文件的约定。 - frontmatter中的
exl-id应为占位符UUID。 发布管道分配实际值。 - 如果用户希望一次创建多个模式,请对每个模式重复第2-4阶段,但在第1阶段中收集所有信息。
- 如果需要上述列表中不存在的新类别,请警告用户TOC.md和overview.md需要创建新分区,并作为单独的步骤进行处理。
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Recherche de Documentation Hono
Documentation
Utilisez le CLI hono pour rechercher et consulter la documentation du framework Hono. Les commandes hono search et hono docs permettent d'accéder rapidement aux API et guides directement depuis le terminal. Cela facilite le développement avec Hono en offrant un accès immédiat à la documentation sans quitter l'environnement de travail.