问题标签 [documentation-generation]

我正在寻找一个文档模板系统，或者更确切地说将创建一个。它应该支持以下功能：

• 以 PDF 和 HTML 创建输出
• 支持大而复杂的 (LaTeX) 公式
• 文档之间的引用
• 参考书目
• 模板将由 Python 脚本填充

我用各种 TeX-to-HTML 转换器尝试了 LaTeX，但我对结果不满意。用DocBook有一段时间了，但是我觉得编辑DocBook不好写，对公式的支持还不够。

主要问题是，该系统的用户不知道 LaTeX 语法或 DocBook。我已经考虑过为这些用户提供使用 Wiki 语法（由 Python 转换为 LaTeX）提供编辑可能性的替代方案。

让我们总结一下：我希望至少来自 LaTeX 和 Wiki 输入的 HTML 和 PDF 输出。DocBook 可以用作中间格式。

有没有人遇到过类似的问题，或者可以就我应该使用哪些工具和哪些文件格式给我一个建议？

我有一个 Silverlight 应用程序，它使用 Web 服务来创建 XPS 文档。文档模板在 WCF 类库中创建为 XAML 控件。

为了将实际数据绑定到我的文档模板，我设置了控件的 DataContext 属性。问题是当我查看我的 XPS 时，图像（我将图像控件的源绑定到代表图像 URL 的字符串属性）没有显示，就好像它们没有加载一样。我怎么解决这个问题？谢谢！

寻找工具（Windows 平台）从现有的 Oracle 数据库生成 ER 图（或类似的）。
有没有免费或低成本的好工具？

请告诉我，是否可以从 Visual Studio 中的标准 XML Doc 生成适当的文档？从 xml 导出到用户友好的外观？

可能重复：
有什么比 PHPDoc 更好的吗？

我想知道是否有支持 PHP 5.3 的文档解决方案。我们在使用 phpDocumentor 时遇到了两个问题。首先，它缺乏 5.3 的支持。其次，在我们的代码库上使用它需要太多内存。

任何人都可以建议 phpDocumentor 的可行替代方案吗？

谢谢！

好的，我知道有用于从 php 代码生成文档的 PhpDocumentor。它似乎很长时间没有更新（但也许他们认为它的大部分功能已完成）。

虽然这可能有利于为其他程序员记录事物，但它似乎不太适合记录 Web 服务的外部“API”。IE，如果我有一个不错的 MVC 结构化项目，PhpDocumentor 可能非常适合为该项目的其他开发人员记录所有模型和内部库等，但我如何记录它提供的 Web 服务？

我在想你可以使用以下标签记录控制器上的方法：

在生成的文档中将显示您需要执行 POST 请求，它返回 JSON 数据，访问它的 URL 是http://whatever.com/device/add。显然会有一个用于定义这些服务调用的基本 url 的文档的全局配置文件。

在这一点上，我想我将自己实现一些东西，使用对 phpdoc 块的反射（或使用带有附录库的注释）并在应用程序中动态访问文档。

Perl 有 Perl 文档生成器吗？Java Docs 或 PHP Documenter 之类的东西？

我的任务是重新设计我部门文档存储库的架构。我们目前在多个 SharePoint 服务器上拥有数百个文档，并希望将它们整合到一个存储库中，以便用户轻松查找和更新他们的文档。

你能推荐任何资源来帮助我在最佳实践、案例研究、技巧等方面帮助我吗？

任何帮助将不胜感激。谢谢。

我正在从事一个 C 项目，该项目已经看到了许多不同的作者和许多不同的文档样式。

我是doxygen和其他文档生成工具的忠实粉丝，我想迁移这个项目以使用这些系统之一。

是否有人知道可以扫描源代码注释以查找“描述”、“作者”、“文件名”等关键字和其他类型的上下文以智能地将注释转换为标准格式的工具？如果不是，我想我可以编写一个疯狂的脚本，或者手动转换。

谢谢

我正在研究我的公司如何制作文档（尤其是编程文档）。我希望能够同步不同 Word 文档的部分，这样如果一个文档中的部分发生更改，则更改会反映在另一个文档中，反之亦然。有没有办法用 Word 做到这一点，如果没有，是否有一些擅长这个的文字处理程序？