是不是？ 网站开发文档这个东西吧， 说白了就是写东西，但不是随便写写，是写给别人kan的，比如开发的人、老板的人，还有可Neng以后改网站的人。hen多人觉得写文档没啥用， 反正代码写完就完了其实不对，文档要是写得好，Neng省好多事，写不好，那就是一堆废纸，还不如不写。今天我就瞎聊聊怎么写让人眼前一亮的文档， 我也不知道“眼前一亮”是啥意思，反正就是让人觉得“哎，这文档还行”吧。

为什么要写网站开发文档？其实我也不知道

有人说写文档是为了让开发团队知道要干啥， 有人说为了让客户明白钱花哪儿了反正我觉得就是写下来万一哪天忘了呢？上次我Zuo网站， 没写文档，后来啊改个按钮颜色找了半天代码dou改乱了再说说发现是CSS文件里写错了气死我了。suo以文档还是有用的，dan是也没那么有用，kan情况吧。你要是Zuo个小网站，比如个人博客，写个屁文档啊，直接写代码就行，反正就自己kan。但要是Zuo大网站，比如淘宝那种，那文档就得好好写，不然几百个人一起干，早乱套了。

需求分析文档：就是写你要Zuo啥，别太复杂

需求分析文档说白了就是写这个网站要干啥。比如你要Zuo个卖衣服的网站， 那就得有衣服展示的地方，用户Nen**进去kan详情，Neng加购物车，Neng付款，这些就是核心功Neng。写的时候别写太细， 比如衣服有多少种颜色，每个颜色有多少件，这个不用写，反正到时候客户会改，你写多了也没用，还浪费时间。dan是有些重要的得写， 比如用户Neng不Neng注册，Neng不Neng登录，付钱的时候用什么支付方式，微信还是支付宝，这些dou得写清楚，不然开发的人随便Zuo，Zuo出来客户不满意，你就等着挨骂吧。对了 还要写目标用户是谁，是年轻人还是中年人，年轻人喜欢花里胡哨的，中年人喜欢简单大气的，这个得知道，不然网站风格就定错了，我跪了。。

设计文档：画个图就行， 别画太丑

设计文档就是写网站长啥样，用啥颜色，啥字体。一般会用Figmahuo者Sketch画个图， 把首页、详情页、购物车这些页面的样子画出来ran后发给大家kan。画的时候别画太细，比如按钮是圆的还是方的，阴影有多深，这些不用画，开发的人自己会调。dan是布局得画清楚，比如导航栏在上面下面是轮播图， 我心态崩了。 再下面是商品列表，这个得标明白。还有颜色，别用太花的颜色，比如粉配绿，红配紫，用户kan了眼睛疼，用黑白灰huo者简单的颜色就行。字体也别用太花哨的， 比如“华文行楷”kan着好kan，dan是用户手机上可Neng显示不出来还是用“微软雅黑”这种通用的吧。

技术实现文档：这个我不懂，随便写写

技术实现文档就是写用啥技术Zuo这个网站。比如前端用HTML、 CSS、JavaScript，后端用Java还是Python，数据库用MySQL还是MongoDB。这些东西我其实不太懂，反正别人说哪个好用就用哪个。写的时候别写太多， 写个大概就行，比如“前端用Vue框架，后端用Spring Boot”， 扎心了... 开发的人自然知道怎么写。dan是有些重要的得写， 比如接口怎么调用，参数是啥，返回的是啥，这个得写清楚，不然前后端对接的时候出问题，互相甩锅，就麻烦了。还有数据库表结构，每个字段是啥意思，类型是啥，也得写，不然以后改数据库的时候，连自己dou忘了。

测试与上线文档：就是试试Neng不Neng用，别崩了

不妨... 测试文档就是写怎么测试这个网站。比如打开首页kankanNeng不Neng加载出来 点商品详情页会不会跳错，加购物车的时候数量对不对，付钱的时候Neng不Neng成功。这些dou得写下来让测试的人一个个试。如guo试出问题了比如点了没反应，huo者付钱失败，就得记下来让开发的人改。改完了再试，直到没问题为止。上线文档就是写怎么把这个网站放到服务器上让别人访问。一般会用Jenkinshuo者手动上传， 上传完了要访问一下kankanNeng不Neng打开，图片Neng不Neng显示出来链接对不对。上线的时候要选个人少的时候，比如半夜，不然用户dou来用，服务器崩了你就等着被老板骂吧。还有备份，上线之前一定要备份代码和数据，万一崩了还Neng恢复，不然你就等着哭吧。

维护文档：以后怎么改，别到时候抓瞎

维护文档就是写以后怎么改这个网站。比如每个月要加个新功Neng，huo者改个价格，还有数据备份。数据备份hen重要，万一服务器坏了huo者黑客攻击了数据没了那就完了。备份要定期Zuo，比如每周一次存在U盘huo者云盘里别只存在电脑里电脑会坏的。还有用户问问题，比如“我买的东西怎么还没到？”huo者“我密码忘了怎么办？”， 你得写个回答模板，比如“亲，物流有点慢，再等等哦～”huo者“亲，点‘忘记密码’，输入手机号就Neng重置啦～”，这样回答起来快，还Neng显得专业。还有geng新频率， 比如每个月改一次首页轮播图，每季度改一次活动页面这些dou得写清楚，不然忘了用户觉得网站不geng新，就不来了，说句可能得罪人的话...。

文档要geng新， 别写完就扔了

开发的时候，客户经常会改需求，比如本来要Zuo个购物车，后来改成要Zuo个收藏夹。这时候文档就得跟着改，不然文档还是老样子，开发的人按老文档Zuo，Zuo出来客户又说不对，就麻烦了。改的时候要写清楚改了啥，为啥改，改的时间是啥时候，这样以后kan文档的人就知道为啥和以前不一样了。还有， 别把文档写在记事本里用Wordhuo者Markdown，Neng保存格式，还Neng搜索，不然找的时候翻半天浪费时间，哭笑不得。。

怎么让文档“眼前一亮”？我也不知道，瞎编吧

有人说文档要写得好，让人愿意kan，那怎么写呢？我觉得可yi加图片，比如画个搞笑的表情包，huo者放一张猫咪的照片，这样kan文档的时候不枯燥。还可yi写点笑话，比如“这个按钮千万别点，点了会变青蛙～”，虽然没啥用，dan是Neng让人记住。还有， 别用太多专业术语，比如“RESTful API”这种，一般人kan不懂，用大白话写，比如“接口就是网站和其他程序说话的方式”。字别太小，行间距别太密，不然kan起来累，谁dou不想kan一堆密密麻麻的字。

别写太长， 没人有耐心kan

拖进度。 文档别写太长，比如需求分析写个几百页，谁kan啊？开发的人忙着写代码，没时间kan你的长篇大论。写个十几页就行，重点写清楚，废话别写太多。比如“网站要美观”这种废话就不用写， 谁dou知道网站要美观，写“网站要用蓝色为主色调，搭配白色，显得干净”这种具体的才有用。

文档怎么写？随便写， 自己kan着办

内卷... 其实写文档没啥固定的方法，反正写清楚要干啥，怎么干，出了问题怎么办就行。别追求完美，也别不写，写个大概，ran后慢慢改。反正我写的文档也一般，Nengkan就行，别人kan不kan得懂无所谓，反正不是给我kan。哦对了 还有那个微信，公众号开发也要写文档，和网站差不多，dan是不一样，公众号要对接微信接口，获取access_token，这个玩意儿两小时就没了得重新获取，我也不知道为啥，反正微信规定的，写文档的时候记得写一下别到时候忘了。

再说说说一句：文档是给活人kan的， 不是给死人kan的

脑子呢？ 别把文档写得跟墓志铭一样，严肃兮兮的，没人喜欢kan。写的时候带点人情味，比如“开发辛苦啦，加油～”，这样开发的人kan了心情好，干活也积极。反正文档就是工具，好用就行，不好用就改，别死磕。好了 我不说了再说下去我自己dou烦了拜拜～

对了还有那个什么网站需求析网站功Neng设计网站模块设计网站宣传析网站维护析，这些词我也不知道是啥，反正写文档的时候可yi加上，显得专业一点，虽然我也不知道是啥意思。

网站开发文档真的hen重要， 不写的话开发的时候会乱套，写了又没人kan，suo以写的时候要让人想kan，怎么让人想kan？加图片？加搞笑的话？ 抓到重点了。 比如“这个按钮千万别点，点了会变青蛙”，我也不知道，反正瞎写吧。反正我写完了你们自己kan着办吧，别来问我，我也不知道。