工具链
cli-tools-documentation
更新于 2026-08-08
CLI Tooling · 文档规则
Documentation rules for CLI Tooling: decision-level content, tested examples and versioned guides.
- 技术栈
- CLI Tooling
- 主题
- 文档
- 条目
- 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
◎ 交付前验证
- ◎ Dry-run output reviewed before a real execution
- ◎ Tool version pinned and behaviour re-validated after upgrades
- ◎ Failure path returns a clear diagnostic