如何写好项目文档_项目设计文档怎么写，2024年最新Golang开发面试技能介绍

先自我介绍一下，小编浙江大学毕业，去过华为、字节跳动等大厂，目前阿里P7

深知大多数程序员，想要提升技能，往往是自己摸索成长，但自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年最新Golang全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上Go语言开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以添加V获取：vip1024b （备注go）

正文

什么时候需要些文档？

• 必须的文档

• 需求设计文档：需求， 重点，取舍过程
• 接口文档： 函数， 参数， 返回值
• 边界性的算法文档： 思路， 关键点
• 系统总体框架： 全局的思路

• 凡是不那么“显而易见”的地方，最好都留下文档
• 文档中不仅仅留下设计的结果（what), 也要留下思考的过程（why）: 留下决策的依据，便于后面的工作
• 文档不是写完代码后补出来的！

• 文档是设计过程中使用的工具、和设计过程的结果

文档书写规范

• 封面

• 编号（用于Reference），项目，版本号

• 历史说明
• 修订人、修改日期、修改说明
• 字体
• 宋体，五号字， 单倍行距
• 文档结构
• 分层次的标题

文档的存放

• 这里推荐一个比较实用的做法
• 你可以根据自己的情况来设计一个存档方式
• 将文档（word格式)保存在svn上
• 容易看到本地和远程的不一致
• 在wiki上建立文档的索引
• 便于看请全局的情况（内容分布，时间分布）

文档内容的书写

• 文档的格式
• 文档的逻辑
• 文档的评价
• 文档的书写方法

文档的格式

• 格式表现的是一种逻辑
• 可能的逻辑关系： 总-分，递进， 并列， …
• 标题

• 标题是否表达文档的内容
• 标题是否和文档的内容相符合
• 各层标题所构成的提纲，是否能清晰反映文档的内容？

• 段落

• 段首一定要有缩进
• 段落不要太长
• 注意每段的第一句话
• 每段内的多句话应该有一定的逻辑

文档中问题的划分

• 选择合适的角度
• 从不同的角度看到的东西是不一样的（类比：汽车不同角度的riew）
• 角度的说明： 说明划分问题的出发角度
• 注意联系： 子问题之间的联系
• 是否是一个独立的问题
• 切分问题是否准确
• 是否是一个重要的问题
• 决定写作的详略。

选用合适的表述模式

• 不同种类的问题，有不同的模式
• 分析和解决一个问题： 提出问题，分析问题，解决问题
• 提出一个实现的建议： 出发点（目的），手段，工作量估计，收益的估计
• 系统的设计： 模块，功能，过程
• 程序的设计： 数据，函数，模块，调用过程，系统结构

文档的评价

• 文档是写给别人看的！
• 能否让读者在5分钟内看懂
• 能否做到问题清楚、重点突出、逻辑清楚？
• 能否做到言之有物： 不要死套格式
• 能否做到言简意赅：不要说废话
• 能否避免造成别人的误解
• 不要说模棱两可的话
• 要注意自己的表达是否通俗（有太多人说“自己才懂的方言”）

文档的书写方法

• 拉提纲，自顶向下

• 大的标题下列出子问题，再对每个子问题逐步展开

• 反刍
• 感觉（一句，一段，甚至整个文章的结构）不好之后要及时修改
• 提高自己写文档的能力
• 让重要的内容醒目
• 标题： 段首第一句话：
• 加重、有颜色、或者带下划线的文字

文档中配图的指南

• 要明确这个图片的目的
• 只能展现1-2个（最好是一个）主要问题
• 只能说明一个层次上的问题
• 要明确图片中传递信息的重点
• 要注意图片中面积的使用
• 可能错误：太多空白的区域，说明的文字过小
• 图片最好能独立说明一个事情
• 同时太多的关注点 =》 失焦
• 对于图片中不能明确表达的地方，需要在图片周围的文字部分给出辅助的说明

文档的review

• 有太多文档的review是无效的！
  -Q（leader): 这个文档你reciew过了， 为什么质量还这么差？！
  -A（reviewer)：这个文档的内容我也感觉是模模糊糊的…
• 甚至有很多文档写出后，根本就没有被（仔细）看过
• 写这样的文档有什么用？
• 文档的review是一次在大脑中的“重放过程”
• 尝试follow作者的思路，看看是否可以走通

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加V获取：vip1024b （备注Go）

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！
以添加V获取：vip1024b （备注Go）**
[外链图片转存中…(img-0t7MfJsB-1713483621469)]

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！