使用MAML进行图书馆的概念性文档编制

Question

我正在研究一个新的图书馆，并且我正在使用XML注释以及SandCastle的API文档，它非常适用。

但我需要编写额外的文件覆盖的概念，总体架构，工作演示等，类图等

我有两个选择：

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

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

您是否使用MAML/Wiki进行此项目的学习？你会建议我什么？

Answer 1

个人而言，我喜欢有维基的工作自由。在这一点上，你有几个像样的选择，编辑MAML

• DocProject
• Sandcastle Help File Builder

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

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

• 您是否有任何要求将文档发送到一个包中的要求？就我而言，我需要将所有东西都放在一个很好的编译包中。你不能这样做W /一个Wiki，但你可以做到这一点与Sandcastle。
• 你会成为唯一一个更新概念内容的人吗？大多数维基都有一个非常好的编辑器，并且可以在主题之间快速链接。您需要编辑内容的唯一工具是浏览器，这可能是技术要求不高的作家的要求。