想把手头上的项目文档化，尽可能的对他人友好，有什么需要注意或者能给参考下的呢？

2017-10-13 13:49:30 +08:00
 crazybinggan

自己动手写了下（参考网上的文档），然后给其他人过审，虽然都觉得还行，但是自己总觉的缺些什么就是没头绪。

所以冒昧上来请教下，一般内部的项目文档化该哪方面着手？

996 次点击
所在节点    问与答
2 条回复
Felldeadbird
2017-10-13 14:40:39 +08:00
不要想着对他人友好。你应该尽量让文档 能够通过机器生成。因为很多时候，随着版本迭代，你会发现你的文档跟不上进度。然后你就不想在更新文档了。
coderluan
2017-10-13 14:45:30 +08:00
规范化+自动化

这是一个专为移动设备优化的页面（即为了让你能够在 Google 搜索结果里秒开这个页面），如果你希望参与 V2EX 社区的讨论，你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/397339

V2EX 是创意工作者们的社区，是一个分享自己正在做的有趣事物、交流想法，可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX