当前位置 博文首页 > 闭曈彤的博客:项目详细方案简洁、美观的写法

    闭曈彤的博客:项目详细方案简洁、美观的写法

    作者:[db:作者] 时间:2021-08-27 16:08

    1. 文档善用分页,每个一级标题/章节结尾处分页。

    2. 表格美观:将内容设置水平居中+垂直居中

    3. 同一内容有两张图的命名方式:课程详情A,课程详情B

    4. 高度概括:对所有的文段,看到标题就能知道内容。

    5. 技术方案写法:在文字、图片里体现出技术+此技术在项目里的运用,禁只介绍技术,不结合具体项目的写法。

    6. “用户”应写成具体的角色名,如学员,教师。

    7. “如下图所示”应写成“如图3-1所示”。

    8. 在前言/综述中应提到用户痛点。

    9. 插入图片的排版方法:展示整体页面(如主页,搜索页),一行可放2-3张;强调细节/特色功能的可以只放一张大图。

    10. 方向/目标的写法:禁用功能性名词(例:采用了xx技术)要用大词,不能落实到具体的实施方案。

    11. 描述XX的解决思路:画思维导图

    12. 画图和排版对齐很重要:例如方框要对齐
      这里写图片描述
      改成下图:
      这里写图片描述

    13. 介绍框架/技术写法:
      a. 介绍这个框架是什么,有啥优点(先进、稳定、成熟 )
      b. 在你的项目里怎么去用它
      c. 带来了什么好处

    14. 避免毫无意义、繁琐的罗列(如把前后端每个接口都列出来),从审核方的角度思考,这个内容别人能看到什么有价值的信息。

    15. 画图的原则:第一看得清,第二美观。底色和文字色对比度要高(一深一浅),且不能用同色系。举例:左边错误,右边正确。

    这里写图片描述
    16. 对出现的每一张图片/模型都应有文字加以解释。

    17.用词要准确,如聊天不可扩大为“社交”。

    18.在高级编辑模式下删除多余的复制痕迹和回车键,不能直接删除的回车键可以试试shift+下方向键+删除。

    cs