Re: 需要文档？请帮助我们！就我而言，文档是当前 XOOPS 最重要的一部分。每个人都请求良好的、清晰度高的定制文档，现在是开始制作的时候了！
加入文档小组，让 XOOPS 成为最佳的、最友好的 CMS！
Herko
Re: 需要文档？请帮助我们！Hi hsalazar，
我喜欢你整理的这个文档的外观和内容。非常光滑、引人入胜。此外，我特别喜欢看到分号用于良好的修辞效果！
我有两个意见
1) 将发布新的XOOPS版本，这将使现有文档过时。在您写的论文中没有解决这个问题。我认为版本号应体现在命名规范中。此外，文档的版本控制和分支需要一些大纲。例如，您是否通过显示行内修正和修订来更新文档，还是简单地覆盖旧版本？
2) 在安装和“入门”方面的内容似乎存在一定的重复。文档中指定了两组用户“用户”和“新手”，看起来似乎为这两组都提供了相同的指令集。我认为应该制作一套涵盖了所有用户级别的良好安装和用法文档，而不是将精力分散到两个部分。同样的问题也适用于为用户和新手都定义的许多其他重叠文档。
谢谢！
dooder
Re: 需要文档？请帮助我们！dooder
您提出的问题确实很有趣，但我必须指出，这些问题并没有被忽视。让我更具体地谈谈。
1) 我非常清楚每个XOOPS版本的过渡性质，也清楚我们所编写的任何文档的暂时性。请相信我，我知道：我之前为Tiny Content编写了一个小块视觉指南，现在已经过时了——尽管我们使用的是TC 1.2，而现在我们已经是TC 1.5了！
这个问题在文档路线图中被处理了两次：首先，HTML被定义为“基本格式”，这意味着我们打算尽可能使HTML版本保持最新，而只有在必要时才将内容合并到实体版本中。
其次，文档命名约定确实在其末尾有一个表示文档版本的数字格式X.XX。
现在，我想您是在谈论在文档名称中包含XOOPS版本，这是一个有趣的想法，我将探讨其影响。感谢您提出这个想法。
这个约定需要更多结构，我知道，所以有一个清晰的逻辑性。正在着手进行。
我们将有一个分步骤的过程来生成新文档，我们将保留过时的版本，不一定在网络上发布。无论如何，我们提供给网上的一切都将清楚地描述其版本、适用的XOOPS版本以及用户需要的任何信息，以便用户知道他们正在下载什么。
2) 由于许多人都在安装过程中遇到麻烦，因此在安装和操作方面的文档列表中确实存在重复。这与在核心安装完成后在XOOPS站点的*构造*中遇到麻烦不同。
常规用户文档和新人文档之间的区别主要在于文档的视觉负荷。我们的想法是，普通用户熟悉很多事物，因此他们的文档将更像参考文档。对于新手来说，我们的想法是他们需要一步一步前进，为此我们希望有步骤的、直观的教程。当然，关于所涉及的劳动量，您说得对。对于文档团队来说，当然最简单的解决方案是建立一个巨大的在线XOOPS圣经，并让用户在这里找到自己的路，但我不赞成这种做法。
当然，我们将从一些基本文档开始，然后逐步推进。我只是觉得有必要有一个理想状态的全面视图，以便有一个可以跟随的愿景。
感谢您的评论。
晚安。
Re: 需要文档？请帮助我们！关于您文档的“基本格式”有一个问题。您提到有一个HTML版本应该是最新的，还有物理版本。
在您的XA-0001.pdf中，您提到了四种不同的
文档输出格式（或基本格式），以及同时拥有这四种格式是何等困难。
当我想到一个文档格式时，我会想到XML作为基本格式。
特别是Docbook XML。
使用Docbook，您可以在理论上非常容易地生成PDF、HTML、RTF文档。
当谈到文档的文件命名规范时，图片又是如何处理的呢？
例如，我们有不同版本、不同模块等的截图。
Re: 需要文档？请帮助我们！robekras
您的观点正确，使用XML作为基本格式比HTML更为灵活。这就是我需要帮助的原因。我的专长不是技术，而是内容；也就是说，我更多的是一个作家，而不是一个技术专家，所以任何人在这里提供的帮助都将受到欢迎。至于“基本格式”，我指的是用户看到的文档方式。说实话，我的“基本格式”仍然是ASCII文本（哈哈）。
无论如何，您的评论提出了关于产品总体文档策略的一个非常好的问题。因为在原始版本中，我也忽略了一点，比如Word文档和CHM文件等具有不同的功能。因此，我们可能需要决定哪些文档应该是多格式的，哪些可以只有单一格式。
建议的规范列出了文档版本而不是所记录软件的版本，但在实际上，我们确实需要清楚地说明我们要记录什么。这同样适用于截图。如果文档版本为1.10，讨论了模块Whatchamacallit版本2.34，那么其中的图像应与该版本相对应。
感谢您的评论。
晚安。
Re: 需要文档？请帮助我们！Horacio
我更是一个技术专家，所以我不太是一个文档撰写者。
（并非说我不喜欢写文档 
）。
我不确定是否有能力帮助您撰写文档（或许值得一试？）。
每个文档格式都有其优缺点。
所以我想给您解释一下关于docbook XML的一些优缺点（如果您已了解，请见谅）
优点
- 基本上，XML文件是用纯ASCII或UTF-8编写的，当然还有其他方式）
- XML文件可以作为文本文件在CVS中处理。这使得版本控制、同时编辑等更加容易。
- Docbook XML可以很容易地转换为HTML（单文件或分块）、CHM、PDF。
- 自动创建XML应该非常简单。例如，自动编译FAQ、故障排除等文档（通过脚本从数据库中输出）
- 平台无关性
缺点
- 虽然有些XML编辑器可用（商业和开源），但对于大多数人来说，编辑XML不如使用WYSWYG编辑器那样容易。
- 您必须学习（并检查）docbook 标签。
如果您使用 Windows，我可以为您提供一些设置 docbook 环境的基本知识。
我还可以提供一些示例文档和批处理文件，用于将文档转换为 HTML、PDF 和 CHM。
希望您对文档工作组的工作有所回应。
我认为有了您在路线图中描述的文档，XOOPS 将会向前迈出巨大的步伐。
罗伯特
Re: 需要文档？请帮助我们！Robekras
我的团队已经有 9 名成员了，但当然如果您想参与也欢迎。
正如我之前提到的，我喜欢内容在不同格式间重复使用的可能性，但我也必须考虑到帮助文件、在线文档和实物文档有不同的内部逻辑，所以问题变成了如何在减少工作量和为媒体提供更合适的文档之间找到一个合适的平衡。
我使用 Windows，当然我也想学习如何设置 docbook 环境。关于这方面您可以提供的任何帮助，我都会很感激。
愿一切顺利
Re: 需要文档？请帮助我们！这是一份非常好且雄心勃勃的路线图。不过，在阅读它时，我产生了两个疑问
1) 不是改进的上下文帮助可以减少对正式文档的需求吗？
2) 那终端用户文档（如关于 BB 发帖或新闻模块管理的常见问题解答）怎么办？
我正在为准备将我的第一个网站推向广泛的用户社区，非常关注第 2 点，因为我试图将单一架构师转变为管理团队。
| Stats | |
| Goal: | $100.00 |
| Due Date: | Aug 31 |
| Gross Amount: | $0.00 |
| Net Balance: | $0.00 |
| Left to go: | $100.00 |
 |
|
