元素页面模板
使用此提示框元素模板,立即定义用途、位置、参数、可移植语法、可访问性、示例、内容限制和质量检查规则。
提示框解决了一个优先级问题:有用的可选建议可能会消失在冗长的操作流程中,然而将其移入主体流程又可能使必需的步骤看起来比实际更长或更严格。该元素在改善执行而不改变"完成"定义的建议周围创建了一个可见的边界。本文档展示了锁定14块元素模板中的每一个区块。
为什么此元素很重要
读者扫描指导性页面是为了寻找决策:哪些是必须做的、哪些可能出错、以及哪些可以让工作更轻松。提示框为可选指导赋予了稳定的视觉和语义角色。它的标签让读者在阅读内容之前就能了解建议的性质。这降低了将可选优化误认为是必需验收条件的风险。
机器可提取性意味着自动化系统可以识别一个有边界的内容块,并在周围页面不存在时保留其含义。提示框的显式标签、简短标题和自包含主体有助于改善这种边界。该框在纯文本形式下也应具有意义:“提示——检查分母:仅当两个百分比使用相同的总体和周期时才进行比较。“视觉样式有助于人们扫描,但文字承载了含义。
当该元素沦为装饰时,它就失败了。像"记住要创造优质内容"这样的泛泛鼓励既不提供决策、技巧,也不提供后果。同样,如果作者将关键要求隐藏在视觉上可选的容器中,也属于失败。
何时使用及何时不使用
当建议是可选的、具体的、与所改进的任务相邻且无需长篇解释即可理解时,请使用提示框。合适的场景包括:高效的流程顺序、有用的诊断方法、可逆的快捷方式、验证技巧,或避免返工的特定上下文方式。
请勿将提示框用于安全警告、法律限定、不可逆操作、必需输入、验收标准、读者后面需要的定义,或支持主要论点的事实。对于可能使结果无效的条件,请使用important标注。将必需操作放入编号流程中。将证据放入其支持的散文或表格单元格中。
文档中的位置规则
位置承载含义。提示框最有效的位置是紧接在其所改进的说明或解释之后,因为读者无需将建议记在脑子里就能直接应用。它不应打断直接答案,不应将句子与其证据分开,也不应位于标题与定义该标题的段落之间。
提示框位置规则
| 位置 | 是否允许? | 原因 | 操作 |
|---|---|---|---|
| 紧接在首屏下方 | 通常不允许 | 读者尚未获得足够上下文来判断可选建议。 | 以直接答案或问题开头。 |
| 在相关说明之后 | 允许 | 技巧在使用时刻立即可用。 | 保持每个框只包含一个可选改进。 |
| 在有序列表项内部 | 不允许 | 嵌套强调会模糊步骤边界,并可能破坏可移植渲染。 | 将其放置在完整步骤之后。 |
| 在破坏性或不可逆操作之前 | 不允许 | 标签低估了后果的严重性。 | 使用重要警告并说明恢复限制。 |
| 在长章节之后 | 仅限有明确范围时 | 读者可能不知道提示修改的是哪条说明。 | 在标题和首句中指明目标操作。 |
结构
该结构包含四个有意义的区域。类型控制严重程度和标签。可选标题指明操作或决策。主体给出一种技巧及其后果。周围位置将提示与其所修改的说明连接起来。间距、边框、图标和颜色属于设计系统;作者不应将这些编码到内容中。
标注必须标识语义区域,而非像素尺寸。即使视觉标记日后发生变化,这些标签仍然有用。
设计示例
图库应展示该元素在真实内容压力下的表现:一句短提示、两段式提示、包含行内代码的提示以及窄视口场景。保持底层建议不变,以便评审者可以比较换行和层级结构。
文件存在后,使用features-with-4-images-grid进行渲染。图库组件优于产品图片网格,因为它将中性规格与恰好四张图片配对,且不引入商业控件。
参数
参数是一种接口契约。精确的类型和限制可防止一位作者编写标签而另一位作者将相同含义编码为主体散文。来源列说明谁拥有该值,以便评审者知道是修复内容、元数据还是组件。
提示框参数
| 名称 | 类型 | 是否必需 | 最小/最大 | 来源 |
|---|---|---|---|---|
| type | 枚举 | 是 | 必须为 note、tip、important 之一 | 作者,根据语义后果选择 |
| title | 纯字符串 | 否 | 2–7个词;最多55个字符 | 作者;默认使用类型标签 |
| body | Markdown | 是 | 1–2段;20–80个词 | 作者,依据批准的简报和证据 |
| 行内链接 | URL加锚文本 | 否 | 0–1个链接 | 已验证的内部或主要外部来源 |
| 位置 | 文档关系 | 是 | 一条相邻的说明或解释 | 文章类型结构和作者判断 |
这些是编辑限制,而非渲染器验证。超出限制需要有在评审中可见的理由。如果主体需要多个子标题、列表或引用,它很可能是一个章节而非提示。
语法与代码示例
以下标记方式具有相同含义。可移植Markdown使用可由不同发布系统转换的指令。Hugo使用现有的callout短代码。WordPress使用项目级短代码表示;WordPress实现必须注册该短代码或将结构映射到自定义区块。
在你的发布系统中复制提示框
在所有三种标记方式中保持类型、标题和主体一致。
可移植Markdown
:::tip{title="检查分母"}
仅当两个百分比使用相同的总体和周期时才进行比较。
:::
Hugo
{{< callout tip title="检查分母" >}}仅当两个百分比使用相同的总体和周期时才进行比较。{{< /callout >}}
WordPress
[tip title="检查分母"]仅当两个百分比使用相同的总体和周期时才进行比较。[/tip]
这解决了模板的主要复用风险。现有的标签页组件接受代码块,不需要图片,暴露了标签页和面板角色,并支持三个固定标签。创建新的短代码将重复已有的功能并增加一个新的界面需要维护。
好与坏示例
这段内容有效是因为它给出了具体操作,解释了原因,并且在更广泛的分析流程中保持可选性。
措辞清晰,但类型是错误的。法律批准是必需的关口,因此将其作为提示呈现会低估后果。将其移至主检查清单中或将标注标记为important。
另一个薄弱示例是"专业提示:优化你的内容以获得更好效果。“它不包含可观察的操作、约束、方法或"更好"的定义。删除它,或用读者可以执行和验证的技巧来替换。
Schema标记与可访问性
提示框不需要独立的Schema.org类型。它仍然是包含它的Article或TechArticle的一部分。不要将可选建议标记为HowToStep;这样做会错误地将其提升为必需流程。如果根据网站政策,页面本身符合HowTo模式的条件,则只有必需的步骤才属于步骤序列。
可访问性始于文本语义。可见标签必须写明"提示”;颜色和图标不能单独承担区分作用。标题应描述操作,主体应按文档顺序可读,链接应在视觉框外也具有意义。避免全大写主体文本、仅表情符号的标签、嵌套的交互控件,以及比普通段落更难导航的一系列相邻框。
当前的callout渲染器输出一个带标签的容器和Markdown主体。作者仍负责有意义的措辞、框周围的标题顺序、描述性链接,以及在代码或表格会创建不可读的嵌套界面时将其放在外部。
写作规则
以操作开头。在同一句或下一句中解释好处或避免的失败。每个框使用一个想法,20–80个词,不超过两个短段落,最多一个链接。当仅用"提示"无法揭示它修改的是哪条附近说明时,优先使用自定义标题。
使用直接、平静的语言。不要用"总是”、“从不”、“关键"或"必不可少"来夸大可选建议。不要仅仅为了让页面看起来有设计感而添加提示。如果信息是核心内容,请将其放回主体叙事中。如果只是令人愉快的鼓励,请删除。
重复的提示聚集在一起表明存在结构问题。将相关建议合并为一个子章节,或判断哪些点实际上是必需步骤。该元素应增加信息层次结构的对比度,而不是将整个页面变成一个充满竞争框的领域。
哪些文章类型使用它以及用在何处
操作指南在步骤之后使用提示。终极指南在复杂解释之后使用,当一项可选做法可以防止常见返工时。对比页面在方法注释旁少量使用,而非作为证据的替代品。清单在项目之后使用,当建议提高效率但不改变完成条件时。
更广泛的SEO文章类型 目录决定了文档顺序。SEO内容元素 中心决定了元素系列和相关替代方案。页面作者应同时参考两者:元素契约解释框的行为方式,而文章类型解释该框是否应位于该位置。
质量检查清单
如果任何检查失败,评审者应拒绝该元素,即使其视觉处理看起来正确。当作者复制现有页面时,语义误用会扩散,因此纠正类型比保留熟悉的布局更为重要。
常见问题
常见问题
一个页面应包含多少个提示框?
提示框可以包含必需步骤吗?
学院版块布局提供最终的转换面板。可见示例、规格说明、三种标记方式的标签页、内容规则和质量检查共同构成了可实施的元素契约;无需额外的元素专属布局。
准备好付诸实践了吗?
免费检查 · 7天试用 · 无需信用卡