质量与评审
static-analysis-documentation
更新于 2026-09-22
Static Analysis · 文档规则
Documentation rules for Static Analysis: decision-level content, tested examples and versioned guides.
- 技术栈
- Static Analysis
- 主题
- 文档
- 条目
- 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
同分类条目
11 篇质量与评审
Static Analysis 工程规则
Static analysis rules: treat warnings as errors for new code and justify exceptions
质量与评审
Code Review 工程规则
Review rules: risk-first reading, bounded diffs and reproducible verification
质量与评审
Refactoring 工程规则
Refactoring rules: characterisation tests before structural change
质量与评审
Legacy Modernisation 工程规则
Legacy rules: strangler-fig slices with a measurable seam
质量与评审
Error Budget 工程规则
Reliability rules: error budgets gate feature work, not opinions