之前写过一点小东西,为了让它更成型一点,我决定给它写个文档。可是这难倒我了,以前压根就没写过正规的文档。目前写东西都是人肉写文档的,直接HTML页面或者GithubWIKI。写久了之后就发现这样实在是太不便于管理了,如果某个功能有更新,想修改文档还得找一下,还指不定都找全了(当然可能是我写文档的思路有问题)。所以在这请教一下大家,如何给程序写文档,因为写的是PHP的程序,希望大家能偏向这边答一点,虽然说写文档这东西跟语言真的无关就是了。以及希望大家从以下几个方面回答问题:怎么写好文档用什么写文档如何方便的管理/更新文档写文档需要注意什么
添加回答
举报
0/150
提交
取消