使用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。
• 你會成爲唯一一個更新概念內容的人嗎？大多數維基都有一個非常好的編輯器，並且可以在主題之間快速鏈接。您需要編輯內容的唯一工具是瀏覽器，這可能是技術要求不高的作家的要求。