Skip to content

27 文档 UI 与文章设计 Cookbook

1. 页面结构模板(推荐)

每篇长文统一结构:

  • 背景与目标
  • 结论先行(TL;DR)
  • 分步骤正文
  • 验收清单
  • 常见失败与回滚

2. 视觉层级模板

  • H1:主题与目标
  • H2:步骤或模块
  • H3:细节与案例
  • 用卡片/表格表达对比,不要堆大段文字

3. 组件化建议

  • 首页:特性卡片(已接入)
  • 文章:
    • 风险提示块(Danger)
    • 结论提示块(Tip)
    • 实操清单(Checklist)

4. 可读性参数建议

  • 正文字号:16px
  • 行高:1.65~1.8
  • 段间距:0.8~1.2em
  • 移动端减少卡片阴影与装饰性渐变

5. 内容密度控制

  • 每个小节不超过 6 条要点
  • 复杂内容优先“表格 + 示例”
  • 每章至少给 1 条“马上可执行”的命令或配置

6. 文章质量评分(内部)

  • 可执行性(30%)
  • 准确性(30%)
  • 可读性(20%)
  • 可维护性(20%)

7. 10 轮持续优化脑暴(本轮)

  1. 每章加 TL;DR
  2. 每章加验收清单
  3. 每章加回滚路径
  4. 统一术语表与链接锚点
  5. 增加“本章耗时”预估
  6. 关键图表统一风格
  7. 英文页保证最小镜像
  8. 加入“最近更新”区块
  9. 建立章节 owner
  10. 每月清理过时内容

基于官方文档与 Schema 编写;示例不包含任何密钥