谨慎使用图表¶
图表可以是有用的工具,帮助用户可视化复杂的流程。然而,图表有时可能过于简单化,反而会使用户感到困惑,适得其反。是否使用图表的决定取决于每个项目的具体情况以及贡献者和审查者的判断。
何时使用图表¶
在 OpenStack 文档中,以下情况可以包含图表
如果存在流程的证据,无论该流程是自动化的还是手动操作的
示例:基本设置工作流
如果需要澄清配置和参考架构
示例:代码审查,上游环境与本地环境
何时不使用图表¶
以下情况不应包含图表
当工作流过于简单时
当没有与 OpenStack 项目的交互时
当配置可以通过文本轻松解释时