如何正确记录您的程序

Question

我开始一个新的项目，现在，这会是一种“插件”或插件”一个更大的已经finsihed工具。

我想这样做right this time并尝试除了一个好的项目结构（文件夹，项目文件夹，类别等）以外，还有一个很好的文档。

是否有任何最佳实践来记录开发过程？当然我会在代码中编写XML-Comments。我不是（主要）询问如何记录代码（How do you document your application），但是如何记录整个系统。所以说更抽象的基础。

是否有任何模板，最佳实践，如何以及从哪里开始？我已经阅读了关于如何使用域驱动设计等，但文档对我来说只是一个不同的（和奇怪的）... ...

编辑：要添加评论中已被注册的信息：

1）这是一个封闭源码的WPF桌面应用程序。

2）文档的目标读者将是我的同事，继任者和我自己的以后维护。另外我想练习写作文件等......我刚上完大学，需要练习:)

Answer 1

有一个叫做arc42的模板。我还没有使用它，但我读了一篇非常有用的文章，我将在未来几个月使用它来记录一个大型系统。