Home
Sign Up
Sign In
V2EX
›
问与答
想把手头上的项目文档化,尽可能的对他人友好,有什么需要注意或者能给参考下的呢?
crazybinggan
·
Oct 13, 2017
· 1542 views
This topic created in 3307 days ago, the information mentioned may be changed or developed.
自己动手写了下(参考网上的文档),然后给其他人过审,虽然都觉得还行,但是自己总觉的缺些什么就是没头绪。
所以冒昧上来请教下,一般内部的项目文档化该哪方面着手?
文档
头绪
参考
请教
2 replies
•
2017-10-13 14:45:30 +08:00
Felldeadbird
Oct 13, 2017
1
不要想着对他人友好。你应该尽量让文档 能够通过机器生成。因为很多时候,随着版本迭代,你会发现你的文档跟不上进度。然后你就不想在更新文档了。
coderluan
Oct 13, 2017
2
规范化+自动化
About
·
Help
·
Advertise
·
Blog
·
API
·
FAQ
·
Privacy
·
Solana
·
4652 Online
Highest 6679
·
Select Language
创意工作者们的社区
World is powered by solitude
VERSION: 3.9.8.5 · 41ms ·
UTC 03:50
·
PVG 11:50
·
LAX 19:50
·
JFK 22:50
♥ Do have faith in what you're doing.
❯