文档写作核对清单 · WRITING-CHECKLIST
面向 inferEra-docs 全部 9 语言文档(更新日志 / 博客 / API 与客户端指南 / 代码示例)。定稿前逐条过一遍;红线摘要见CLAUDE.md 的「写作红线」。
1 · 事实与口吻
- 只陈述事实,无推测、无营销夸张、无主观评价(不用「强大」「极致」「颠覆」等)。
- 每条能力 / 参数 / 价格都可核实,来源明确。
- 口吻为官方规范表述:「现已支持」「无需改动」「可自定义」;不用口语(「挂了」「就行」「逛逛」)。
2 · 专有名词与模型描述
- 模型名、参数量、上下文长度、协议名、功能名一律取官方文档 / 官方页面口径。
- 模型描述必须查官方文档,不得杜撰;拿不准的能力宁可不写,不臆测(例:
tencent-hy3是文本 LLM,非 3D 模型)。 - 模型 ID、代码、价格、URL、图片路径在翻译 / 复制时保持原样不变。
3 · 禁止的修辞句式
- 无任何比喻、类比、拟人、形象化修辞。
- 无「不是……而是……」及一切「先否定再转折」的对比句式,改为正面直述。
- 无反问、无感叹渲染。
4 · 不暴露内部平台逻辑(安全红线)
- 不写渠道路由 / 渠道名单 / 优先级等内部机制。
- 不写计费实现细节:白名单、前缀匹配、少计费 / 补计费、计费 bug 归因。
- 不写运营策略、内部重构、监控、CI 等用户不可见事项。
- 计费 / 稳定性类变更用中性能力表述:如「长上下文模型计费覆盖扩展」「多渠道重试稳定性优化」,不点名具体 bug。
- 已回滚的改动,文档中不留任何痕迹(不提「曾经不支持」)。
5 · 代码示例
- prompt 统一用英文(如
"What is the meaning of life?"、"A man smiling and waving hello")。 - 不夹带中文长文本或特定文化 / 历史题材大段引文,避免触发下游内容过滤导致请求被拦。
- 密钥一律用占位符
sk-***或环境变量;AIHUBMIX_API_KEY等绝不写进脚本 / 提交 / 明文。 - 示例可运行,base_url / 端点 / 模型 ID 正确。
6 · 多语言一致性
- cn 定稿后再扇出,8 语言与 cn 事实对齐(数值、模型名、结论一致)。
- 只改当月 / 目标段落,其余不动。
- 站内链接按语言前缀替换(
/cn/→/<lang>/)。 - 栏目名保留:中文「发布聚焦」,其余语言「Release Spotlight」。
7 · SEO / GEO(博客与汇总)
-
description含年月 + 主要模型名 + 新功能名。 - 首屏 hero 图带语义 alt。
- 正文配 3~4 条 FAQ。
- 结构「功能在前、模型在后」;新模型用加粗实体名 + 一句能力描述。
- 跑
python3 scripts/doc_lint.py <目录> -v通过。