写作规范

标签文章: 写作规范

标准

术语与定义：建立术语体系

术语表真正有价值，是因为它能约束产品、界面和文档中的选择，而不仅是收集词语。有用的术语记录不仅解释词义，还应包含首选词、禁用或废弃变体、上下文、语法说明和 owner。

2 分钟阅读

标准

规模化一致性来自内容模型、术语和可复用模式，而不是要求所有人背下巨大 style guide。重要规则应写进 schema 和组件。小团队可以依靠共同习惯和直接编辑。贡献者达到几十或几百人后，记忆就不再是控制系统。

2 分钟阅读

标准

围绕“真正有人使用的写作规范”给出可执行、可验证并且便于长期维护的技术写作方法。从技术写作角度解释“真正有人使用的写作规范”，重点是可执行、可验证和可维护的做法。

3 分钟阅读

工具

样式 linting 最有价值的地方，是发现术语漂移、风险措辞和可重复的编辑缺陷。规则应少而明确，并保持足够安静，让一次失败真正值得作者注意。样式 linter 可以在几秒内检查成千上万句子，因此很容易产生“把所有偏好都编码进去”的冲动。

2 分钟阅读