问题标签 [documentation]

我已经看到它使用了几个地方：

• http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/
• http://developer.yahoo.com/flash/astra-flash/classreference/

这只是巧合还是我可以抓住的地方？我很想将它用于我正在从事的新项目。

谢谢！

对于以下情况，您有什么建议：

十几个开发人员需要构建和设计一个复杂的系统。需要为未来的开发人员记录此设计，并且必须注意设计决策。这些报告需要大约每两个月进行一次。我的问题是应该如何记录这个项目。

我看到了两种可能性。每个开发人员都会写下他们帮助设计和集成的东西，然后一个人将这些文档中的每一个组合在一起。最终的文件有时可能会不连贯或多余，因为负责组装所有东西的人没有太多时间来调整每个部分。

假设每个开发人员的文档部分在截止日期前几天到达。协作系统（即 wiki）将无法正常工作，因为直到截止日期前几天才可以阅读任何内容。

还是应该让少数人（2-3 人）负责编写文档，而团队的其他成员则负责实际开发系统？开发人员需要一种方法将他们的设计选择和结论传递给技术作者。如何有效地做到这一点？

（注意：我意识到这与How do you document your database structure?很接近，但我不认为它是相同的。）

我已经开始在一个拥有数百个表和视图的数据库的地方工作，所有这些表和视图的名称都很神秘，元音很少，也没有文档。他们也不允许对数据库模式进行无偿更改，我也不能触摸任何数据库，除了我自己机器上的测试数据库（它会被吹走并定期重新创建），所以我不能添加对任何人都有帮助的评论。

我尝试使用“Toad”创建一个 ER 图，但在让它连续运行 48 小时后，它仍然没有产生任何可见的东西，我需要我的电脑回来。我正在与其他一些最近的员工交谈，我们都建议，每当我们对特定表或其中某些列的含义感到困惑时，我们应该在开发人员 wiki 中更新它。

那么有什么好的方法来做到这一点呢？只是列出表/视图及其列并在我们进行时填写它们？我手头的基本工具是 Toad、Oracle 的“SQL Developer”、MS Office 和 Visio。

##尝试使用此评论重新打开它

任何人都可以推荐一个程序来创建用户手册吗？不是一种标记语言（如 LaTeX 或 DocBook），而是更像 Scribus 之类的交互式标记语言。由于我不是唯一会更新手册的软件，因此该软件应该是新手容易上手的软件，但仍具有一些高级功能（例如从外部源/表格链接文本，处理母版页/主题等） .

问候，奥斯卡

自从我愤怒地使用Java以来​​已经有一段时间了，所以如果这很愚蠢，请原谅我。

我刚刚开始使用 JAXB 来反序列化传入的 XML 字符串（来自 Jetty 服务器）的 Java 项目。该项目仅针对这种情况使用 JAXB。

JAXB 的替代品是什么？
JAXB 对这些替代方案的优缺点是什么

我进行了一些谷歌搜索并找到了很多参考资料，但是是否有一个明确的来源是 JAXB 问题的转到位置，或者人们只是看到人们在做什么并从那里解释。

谢谢。

如何使用 Doxygen 将 HTML 文档创建为单个非常长的文件？我想要类似 RTF 输出的东西，但作为 HTML。

原因：我需要将我的 API 作为单个可打印文档发布。可以加载到 Word 中、转换为 PDF 等的东西。

阿罗哈

我收到了一个不错的带有 xs: 文档标签的 wsdl，例如：

有没有办法从中生成///<summary>标签？我正在使用视觉工作室 2008

安瓿项目在 docstring 中使用了一些标签，例如 javadoc 的标签。

例如从pool.py第 86 行：

这些标签是什么，哪个工具使用它。

有人制作了德语版的 GhostDoc 模板文本吗？

我正在开发一个可以使用“插件”进行扩展的应用程序。插件将非常基本，允许开发人员向我的应用程序添加新的“操作”。

我需要提供哪些文档/信息，以便开发人员可以做他们需要做的事情？

我在想一个简短的例子和应用程序/插件如何工作的一般概述？