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

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

• 包括什么
• 如何组织？我的意思是，你能建议一些层次结构，这样新的开发人员就可以很容易地走上正轨吗
• 最佳实践是什么
• 你能拿些样品看看吗
• 怎样才能使它变得容易呢？一些ppl建议使用wiki工具，但我对它一无所知，它有用吗？你能推荐一些有快速入门教程的工具吗

我从来没有做过。所以我很感激你的回答。提前谢谢。 （链接会很有帮助，但请提供一个快速清晰的摘要）

快速清晰：

---

把它想象成任何一张纸

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

• 大纲格式很棒

---

除了Nona的建议之外，我还想说，分解代码并解释代码的任何约定和意图非常重要，这样开发人员之间在ID值、CSS类和JavaScript函数名等方面就有了一致性。具体到您认为必要的程度，以防止团队中的新人重新创造工作。

如果您正在寻找快速完成代码的方法，请尝试。它为您提供了所有类、方法、属性等的广泛概述，这样您就可以编写所需的所有技术文档，而无需实际查看这些文件。它非常容易浏览，甚至可以显示代码本身。

您是否考虑过用UML符号表示代码？这就是UML的用途！如果新开发人员很好，那么他们应该能够理解它。

请推荐一个工具来减轻文档编制任务。我认为关于如何描述粗体文本，还有很多需要定义。使用什么图表来设计图表导航、ajax通信等。。。UML作为典型的建模语言并没有覆盖这些差距。