写Java相关的技术文档真是个磨人的小妖精 每次写都感觉脑子不够用,但慢慢摸索出点门道。首先别光盯着代码,要把思路先理清楚,不然写着写着就跑偏了。还有啊,例子一定要接地气,别整那些虚头巴脑的,像我前几天写接口设计文档,直接拿用户登录举例子,简单明了。语言也要尽量大白话,谁有空看你绕来绕去的长句子呀。对了,配图也超重要,一张流程图顶得上千言万语,就是我画图技术有点拉胯,将就着用吧...
登录/注册