Skip to main content

Content Operations

1. 内容分层建议​

为了让文档站点长期可维护，建议把内容分成三层：

产品认知​

  • 产品介绍
  • 适用场景
  • 功能概览

操作教程​

  • 安装
  • 配置
  • 第三方集成
  • 常见使用流程

维护型内容​

  • FAQ
  • 已知限制
  • 版本变化说明

2. 新增文档时的最低标准​

一篇可交付的文档，至少要回答下面四个问题：

  1. 这项能力解决什么问题。
  2. 使用前需要准备什么。
  3. 操作步骤是什么。
  4. 遇到问题怎么定位。

3. 集成文档的推荐模板​

对于 Obsidian、Notion、Webhook 这类集成，建议统一结构：

  1. 适用场景
  2. 前置条件
  3. 配置步骤
  4. 常见错误
  5. 相关链接

4. 内容同步规则​

当下列内容发生变化时，应同步更新文档站点：

  • 官网价格页的能力描述
  • 新增或下线的集成渠道
  • 注册/订阅/支付流程
  • 产品截图和安装入口

5. 翻译策略​

当前站点已启用中文 locale。建议做法是：

  • 先完成英文原文，确保结构稳定。
  • 再补齐 zh-Hans 翻译。
  • 路径和章节命名尽量稳定，避免频繁移动造成链接失效。