需要选择合适的语言来编写文档

目前我工作的文档处于一种状态。没有足够的地方，并且存在的文档遍布在许多文档文档中，这使得很难找到任何东西。需要选择合适的语言来编写文档

我试图采取一些主动，把它提高，我想的第一件事就是找一个更好的格式写的文档：

我的想法是，该文件的结构应在一系列短文章（MSDN/HTML帮助风格）和结构化的适地适树的：
- 这将是很好的能够产生一个独立的HTML的帮助风格封装与应用
- 运以及能够产生MSDN风格的我们作为懒惰看CD的人的参考。
- 搜索当然是必须具备的
它需要至少相当容易更新 - 如果有一个17步骤来更新发布的文档，然后它使得它看起来像太多的工作做简单的改变，并且没有人能够更新它。
该文档本质上是技术性的，因此理想情况下能够包含来自嵌入在C＃代码中的Xml文档等内容的生成文档将会很好。然而，这绝对是一个侧面要求 - 目前Xml文档很少有用，只是在将来我打算解决这个问题。
出于同样的原因，能够处理诸如附件（代码示例等等）这样的东西通常是件好事。我并不期待任何幻想，但这是我需要牢记的事情，以确保它至少处理得不好。

是否有任何项目或语言适合这种文档？

来源

2009-10-14 Justin

我不确定标题中的“语言”这个词是否是描述我要找的内容的最好词 - 如果有人能想到更好的词，那么请继续并改变它。 – Justin

我已经开始使用DokuWiki。它不完全是我最初寻找的东西（我认为我真的在寻找一个CMS），但它完成了这项工作，并且有些方面比我原先想的要好（特别是它的wiki - 我还没有得到尽可能发布到我们的客户，但我不知道这是多么好这将解决）

我使用的插件和Arctic模板来获取左侧的导航树，如果我发布了wiki本身，我将使用discussion plugin来允许用户发布反馈。

目前，我处理生成内容的方法是使用xslt模板生成dokuwiki语法，并将该输出直接写入“data/pages”文件夹中的文件/文件夹。

来源

2009-10-20 15:47:27 Justin

如果您使用的是LaTeX，您可以使用精美的PDF和打印副本获得所有文档，并且可以生成html（通过latex2html）。 TeX的优势在于它也是全明文，因此您可以使用您最喜爱的版本控制系统可靠地跟踪/合并它。

来源

2009-10-14 17:53:42

我们使用confluence作为我们的文档库。公共和私人部分相当容易，并且有一个很好的所见即所得的编辑器。它可以处理附件，并可以保存为PDF文档，如果你喜欢。

来源

2009-10-14 17:59:35 Jay

我已经在我的C和C++项目中使用doxygen获得了很好的结果，尽管它也支持许多其他语言。您可以将代码中的文档放在代码中，这些代码可以是简单或复杂的HTML标记。因为它是代码的一部分，所以更新非常容易。您可以将文档构建为构建过程的一部分。其他不严格与API相关的主题可以添加为单独的HTML文档。我使用的版本不支持搜索，因此您必须添加其他产品才能搜索这些网页。因为它是HTML，你可以添加代码示例，图表等。

来源

2009-10-14 17:59:37

我已经使用robohelp，效果不错。它是纯html，但有一个生成过程，保持翻译看起来一致。它可以打包成应用程序的.hlp文件，或者发布到网站上。检查一下，它很简单，所以你可以回去做你的工作:)

来源

2009-10-14 18:06:46

一个干净的方法是使用DocBook。这很容易写和不被看重。由于XML解析器是标准的，而且其他形式的文档（例如来自注释中的嵌入式文档）可以很容易地转换为这种格式，所以也很容易解析。

直接从DocBook源生成PDF，HTML或其他格式（为此目的而存在工具）。

来源

2009-10-14 18:14:02

需要选择合适的语言来编写文档

回答

相关问题