Back to Details

engram-docs-alignment

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

When to Use

使用场景

Use this skill when:
  • Changing APIs, setup flows, or plugin behavior
  • Updating CLI commands or examples
  • Writing contributor guidance
在以下场景使用本技能：
  • 修改API、设置流程或插件行为时
  • 更新CLI命令或示例时
  • 编写贡献者指南时

Alignment Rules

对齐规则

  1. Docs must describe current behavior, not intended behavior.
  2. Update docs in the same PR as the code change.
  3. Validate examples before publishing.
  4. Remove references to deprecated files, endpoints, or scripts.
  1. 文档必须描述当前实际行为，而非预期行为。
  2. 在与代码变更相同的PR中更新文档。
  3. 发布前验证示例的正确性。
  4. 删除对已弃用文件、端点或脚本的引用。

Verification

验证项

  • Endpoint names match server routes
  • Script names match repository paths
  • Command examples execute as documented
  • Cross-agent notes are still accurate
  • 端点名称与服务器路由匹配
  • 脚本名称与仓库路径匹配
  • 命令示例按文档说明可正常执行
  • 跨Agent说明仍准确无误