遗留应用程序的用户文档的最佳实践

Question

我在遗留应用程序（C++。Net）上工作，我们希望提取一些功能并将其重新命名为单独的产品。很明显，这个'新'产品需要文档，而且与这个功能相关的旧文档是坦率的垃圾。

我正在寻找建议，人们认为什么是向这样的应用程序添加文档的最佳格式。要求包括：

• 文件应与应用
• 基于Web的文档被打包是不是真的相关，但解决方案可以基于的本地基于Web的安装
• 这将是巨大的，如果文件是轻松与应用程序集成
• 有很多范围的FAQ，HOWTO等文档以及标准的综合用户文档
• 该应用程序也是可扩展的，因此支持基于代码的示例等be gr吃。
• 应该由非开发人员

任何提示\提醒我们非常感激可更新。

这些文件应与应用

Answer 1

打包因为你写的非开发人员应该能够更新它，我会去一些wiki解决方案与输出文件的一些流行的格式的能力，这里是wiki的列表：https://en.wikipedia.org/wiki/Comparison_of_wiki_software。你也可以考虑Markdown格式http://en.wikipedia.org/wiki/Markdown，我猜这是文档最轻量级的解决方案。