内容要求

  1. 一个方案设计的主要工作原理,关键需求的设计思路
  2. 针对重要(哪些是这次方案最主要的需求点,82原则)需求点,以面向用户的语言描述其实现思路
  3. 指使用面向用户的语言(不用涉及太多太深的计算机知识),描述各个核心需求点是怎么达成的。
  4. 如果可以,尽可能用一句话描述清楚一个需求点的实现思路。这样做的好处很大:

    1. 可以尽早和干系人沟通思路,快速让干系人理解思路要点;
    2. 可以更加抽象,抓住需求和方案的核心,避免过早纠缠于细节;

      使用场景

  5. 给项目经理、主管、测试等非计算专业的人员 介绍方案时,介绍你方案大致是怎么实现时

  6. 跟架构师、相关专家讨论方案的合理性时
  7. 方案评审前,快速给大家进行简要介绍时

    内容要点

  8. 主要需求

    1. 仅是对最主要(重要)需求实现方案,不是所有需求点都要在这里阐述工作原理,仅是最重要的需求
    2. 最主要需求的最主要实现技术
  9. 高度概括
    1. 没有太多的时间给你解释,一句话最好
  10. 描述易懂
    1. 因为使用场景有较多的 非计算机专业的人员,所以不可使用太过专业化的术语描述,尽量可以口语化、普遍基础的语言描述,通俗易懂
    2. 相应的又要易懂,又要高度概括,所以语言上可以尽量抽象,就是不用讲得那么细
  11. 侧重怎么做

    1. 这里就要侧重写具体是怎么做的,写的是对解决方案的概括,不是写需求

      关注点

  12. 原理/思路 可以写多个

    1. 并不限制只有一个,如果一个方案有多个核心需求,有多个核心方案,就可以写多个
    2. 但同时写多个的时候可关注下不要太突兀,最好有一定的逻辑关联逻辑(多个原理间有什么关系)
  13. 可以写流程、画流程图
    1. 简短的流程说明或者简要的流程图也是可以的
  14. 尽可能用一句话,也可以用一段简短的话
    1. 要点还是高度概括,能精简就精简
  15. 不要贴代码或者过多的专业术语
    1. 比如一个算法设计,不要把核心算法贴了上来,要转换为易懂的语言进行描述

      正例参考

      image.png
      image.png
      image.png

      反例参考

      非专业人员根本看不懂,专业人员不了解上下文,也很难看懂
      image.png