首页
首页
沸点
课程
直播
活动
竞赛
商城
APP
插件
搜索历史
清空
创作者中心
写文章
发沸点
写笔记
写代码
草稿箱
创作灵感
查看更多
会员
登录
注册
明明如月学长
Java高级开发工程师 @阿里巴巴
·
1年前
关注
屏蔽作者: 明明如月学长
举报
【以使用者的角度写文档】
哪怕在BAT大厂很多技术的使用文档,看似非常全面,但是当你带着某个某个具体的业务场景去对接时不知如何下手。
通常需要咨询对应的负责的同学或者早期接入过该框架的同学,才能有些眉目。
大家编写使用文档的时候尽量还是以使用者的角度去编写。
但是人总是很难真正切换视角,要尽可能以使用者的角度编写文档的前提下,不断接受使用方的反馈,不断完善文档才行。
展开
技术交流圈
等人赞过
分享
1
7
相关推荐
#!/usr/bin/env node 这句的原理是什么?为什么一定是这个路径呀?
10 赞 ·
19 评论
要谈大礼包了,有点紧张怎么办
3 赞 ·
25 评论
jym,有碰到过这种问题么?后端接口响应了数据(日志打印了),但是前端接口请求一直是padding...
3 赞 ·
12 评论
相关推荐
#!/usr/bin/env node 这句的原理是什么?为什么一定是这个路径呀?
10 赞 ·
19 评论
要谈大礼包了,有点紧张怎么办
3 赞 ·
25 评论
jym,有碰到过这种问题么?后端接口响应了数据(日志打印了),但是前端接口请求一直是padding...
3 赞 ·
12 评论