使用MAML进行库的概念文档编制

Question

我正在开发一个新的库，我正在使用XML文档的XML注释以及SandCastle，它非常有用。

但我需要编写其他文档，其中包括概念，整体架构，工作演示等，类图等。

我有两个选择：

1. 使用一些wiki引擎并编写wiki风格的文档。
2. 使用似乎是为此目的的MAML。

使用wiki似乎是安全的解决方案，因为有许多稳定，流行和免费的引擎可用，但API和概念文档不会齐头并进（交叉链接，外观等）。使用MAML意味着学习曲线，我不确定它的成熟程度以及它的优点/缺点。

您是否已将MAML / Wiki用于此目的以及您的学习内容是什么？你会建议我什么？

Answer 1

就个人而言，我喜欢用Wiki工作的自由。此时，你有一些不错的选择来编辑MAML

• DocProject
• Sandcastle Help File Builder

我对DocProject说不多（虽然看起来不错）。现在，我正在使用SHFB将API文档和一些概念文档合并到MAML中。编辑很体面，足以满足我的需求。我能够轻松设置目录并在我的API和概念文档之间建立链接。查看示例的一个很好的资源是SandcastleStyles。

与所有事情一样，有一些重要的问题要问。

• 您是否有任何要求将文档发送到一个软件包中？在我的情况下，我需要在一个很好的编译包中发送所有内容。你不能用维基百科做到这一点，但你可以用Sandcastle做到这一点。
• 您是否会成为唯一更新概念内容的人？大多数wiki都有一个非常好的编辑器，能够快速链接主题。编辑内容所需的唯一工具是浏览器，这可能是技术不太精通的作家的要求。