使用MAML进行库的概念性文档

我正在开发一个新的库,我正在使用XML注释来获取API文档以及SandCastle,它非常有效。 但我需要编写其他文档,其中包括概念,整体架构,工作演示等,类图等。 我有2个选择: 使用一些wiki引擎并编写文档wiki风格。 使用似乎是为此目的的MAML。 使用wiki似乎是安全的解决方案,因为有许多稳定,流行和免费的引擎可用,但API和概念文档不会齐头并进(交叉链接,外观等)。使用MAML意味着学习曲线,我不确定它有多成熟,有什么优点/缺点。 您是否为此目的使用了MAML / Wiki以及您的学习内容?你会建议我什么?     
已邀请:
就个人而言,我喜欢用Wiki工作的自由。此时,您有一些不错的选择来编辑MAML DocProject Sandcastle帮助文件生成器 我对DocProject说的不多(尽管看起来不错)。现在,我正在使用SHFB将API文档和一些概念文档合并到MAML中。编辑很体面,足以满足我的需求。我能够轻松设置目录并在我的API和概念文档之间建立链接。 SandcastleStyles是一个很好的资源来查看示例。 与所有事情一样,有一些重要的问题要问。 您是否有任何要求将文档发送到一个包中?在我的情况下,我需要在一个很好的编译包中发送所有东西。你不能用维基百科做到这一点,但你可以用Sandcastle做到这一点。 您是否会成为唯一更新概念内容的人?大多数wiki都有一个非常好的编辑器,能够快速链接主题。编辑内容所需的唯一工具是浏览器,这可能是技术不太精通的作家的要求。     

要回复问题请先登录注册