documentation - 如何为新开发人员编写网站/软件的技术文档？

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改善这个问题吗？更新问题，以便可以通过 editing this post 用事实和引文回答问题.

3年前关闭。




Improve this question




我想为开发人员制作现有网站的技术文档，以便新开发人员可以继续使用它。在现有代码中，很少(或根本没有)代码内注释或文档字符串可用(不好的做法，我知道)。是的，我看过一些与这些相关的帖子。但这些都没有那么详细。这是我所有的问题:

要包括什么？

如何组织？我的意思是，您能否建议一些层次结构，以便新开发人员可以轻松进入赛道？

最佳做法是什么？

你能展示一些 sample 吗？

如何让它变得容易？有些人建议使用 wiki 工具，但我对此一无所知，它会有用吗？你能推荐任何带有一些快速入门教程的工具吗？

我从来没有做过。所以我很感激任何形式的答案。提前致谢。
(链接会有所帮助，但请提供一个快速清晰的摘要)

Answer 1

快速而清晰:

把它想象成任何一张纸。

应用程序(网站)的目标是什么？ [为什么？]
它是如何实现这一目标的？
出现了哪些问题？
会出现什么问题？
可以扩展什么？ [为什么？]
扩容会带来哪些问题？ [为什么？]
应继续遵循哪些命名/格式约定？

大纲格式很棒。