跳到主要内容

文档编写、预览与搜索

本站使用 Markdown 与 MDX。正文保存在 docs/content/,公开图片放在 docs/static/。菜单由 docs/navigation.mjs 统一登记,侧栏不会自动发布未登记的文章。

写作流程​

新增文章时填写 title 和 description,在对应菜单登记文档 ID,再使用相对路径引用其他正文。小程序业务说明需要先核对实现,再提交评审。

操作教程按“入口—关键操作—结果”配真实截图,通常选择 3~5 张关键画面。保留当前角色与必要上下文,不把错误页、骨架或尚未完成的提交作为成功步骤;图注区分原生微信界面与 H5 预览。手机号、邮箱、税号及内部凭据等无关信息需遮蔽。

发布图放入 static/img/guides/,在 governance/screenshot-inventory.json 登记来源、采集环境、摘要、脱敏方式和正文引用。图片支持点击放大;手机截图保持设备阅读宽度,后台操作图可展开查看细节。旧图保留原采集身份与版本,不标为本轮新拍。

使用手册以用户任务为主线,交代入口、前提、步骤、结果和失败处理;二次开发文档需要说明修改入口、合同约束和测试;维护文档需要明确执行目录、参数作用、发布顺序和恢复办法。涉及未开放能力时直接说明限制,不提供虚构的成功步骤。

Mermaid

图表将在进入阅读区域时加载。

图表按需加载,可切换源码、放大预览和下载 SVG。

代码预览​

普通代码块只展示源码。React 示例可用 jsx live,首次点击“运行预览”时加载编辑器。

React 示例
function DocumentPreview() {
return <p>文档示例预览已就绪</p>;
}

HTML 示例使用 html preview,在受限 iframe 中运行:

HTML 示例
<!doctype html>
<html lang="zh-CN">
<meta charset="utf-8">
<meta name="color-scheme" content="dark">
<title>文档示例</title>
<body><p>HTML 文档预览已就绪</p></body>
</html>

本机检查​

npm run build
npm run serve

在构建预览中核对页面、侧栏、搜索及图表。开发服务不能代替构建后的中文全文搜索检查。

noindex 用于限制外部搜索引擎,站内搜索通过 forceIgnoreNoIndex 继续建立索引。新增文章后重建再搜索标题;若搜索不到,检查文章是否成功构建、索引是否非空及是否仍在访问旧构建。

来源与内容维护​

docs/governance/content-inventory.json 记录每篇正文的来源路径和核对时的摘要。修改业务文档时同步复核来源;来源摘要变化只表示需要审阅,不能自动覆盖正文。

工程实现文档仍在 ui/frontend/docs/ 维护。本站提供面向读者的任务说明,不在这里维护第二套字段字典或复制原始运行证据。使用脱敏截图,并记录对应版本和采集环境。