Anydocs Documents
文档编辑器

提示框与引用

区分 Callout 和 Blockquote 的职责,避免把两者都当成“高亮文本框”。

`Callout` 和 `Blockquote` 都会在 reader 里被视觉强调,但它们承担的职责不同。Callout 更像作者主动给出的说明、警告和边界;Blockquote 更像引用、摘录或需要保留原话语气的内容。用错了结构,会让文档显得像在乱用样式,而不是在表达层次。

什么时候用 Callout

当你需要提醒读者注意风险、前提、发布边界、版本差异、权限要求时,优先用 `Callout`。它是作者视角的结构化提示,而不是引用。当前常见主题包括 `info`、`warning`、`error`。

什么时候用 Blockquote

当你要引用外部原话、保留说明原句语气,或者想把一段简短摘录与正文区隔开时,使用 `Blockquote`。如果内容本质上是你自己的操作提醒,而不是引用,请不要用 Blockquote 冒充提示框。

如何避免过度使用

一页里出现太多 Callout,会让读者分不清什么才是真的重要;一页里到处是 Blockquote,则会削弱正文连续性。更稳妥的做法是:正文承载主叙述,Callout 只放少量高价值提醒,Blockquote 只保留确实值得原样保留的引文。

对 AI 与公开产物的影响

Callout 和 Blockquote 都会进入最终 render、plainText 和公开机器可读产物。换句话说,它们不是只给视觉设计看的;AI 也会读到它们。所以 Callout 里的文案应足够清晰,Blockquote 也应避免脱离上下文。

简单判断法: 如果这段话是在说“请注意”,更像 Callout;如果这段话是在说“原文如此”,更像 Blockquote。