我想为开发人员制作现有网站的技术文档,以便新开发人员可以继续使用它.在现有代码中,很少(或根本没有)代码内注释或文档字符串可用(不好的做法,我知道).是的,我看过一些与这些相关的帖子.但那些并不那么详细.以下是我的所有问题:
我从未做过一个.所以我很感激任何答案.提前致谢.(链接将有所帮助,但请快速,清晰地总结它)
快速清晰:
把它想象成任何纸张.
该应用程序(网站)的目标是什么？[为什么？]
它是如何实现这一目标的？
出现了什么问题？
可能会出现什么问题？
什么可以扩展？[为什么？]
扩张可能导致什么问题？[为什么？]
应继续遵循哪些命名/格式约定？
| 归档时间： |
|
| 查看次数： |
18851 次 |
| 最近记录： |