AI 智能体
cross-editor-sync-documentation
更新于 2026-10-21
Cross-Editor Sync · 文档规则
Documentation rules for Cross-Editor Sync: decision-level content, tested examples and versioned guides.
- 技术栈
- Cross-Editor Sync
- 主题
- 文档
- 条目
- 9 条
- 版本
- v0.2.0
✓ 应当这么做
- ✓ Document decisions and invariants, not restatements of the code
- ✓ Keep runnable examples in the docs and test them in CI
- ✓ Date and version external-facing documents
✕ 常见反模式
- ✕ Copy-pasted README sections that drift from the code
- ✕ Docs without an owner
- ✕ Silently dropping deprecated configuration from the guide
◎ 交付前验证
- ◎ Typecheck (`tsc --noEmit` or equivalent) passes with zero errors
- ◎ Lint passes and no rule was disabled inline
- ◎ Node/browser runtime compatibility checked against the project engines field
同分类条目
42 篇AI 智能体
Vector Search 工程规则
Vector search rules: chunking strategy, recall evaluation and index rebuild path
AI 智能体
Feature Store 工程规则
Feature store rules: point-in-time correctness and train/serve parity
AI 智能体
Agent Skill Design 工程规则
Skill design rules: narrow triggers, explicit boundaries and verifiable outputs
AI 智能体
Agent Tool Calls 工程规则
Tool-call rules: server-side authorisation and deny-by-default allow-lists
AI 智能体
Agent Memory 工程规则
Memory rules: scoped retrieval, expiry and user-visible deletion
AI 智能体
RAG Retrieval 工程规则
RAG rules: citation-grade retrieval and evaluated recall before shipping