本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- AboutCode
- 技术文档工程师：
- ayansinha
- 项目名称：
- Scancode- Toolkit 中的命令行选项参考文档，并组织 aboutcode.readthedocs.io 上重新组织了 AboutCode 文档的结构
- 项目时长：
- 标准时长（3 个月）
Project description
[ 1. Scancode-Toolkit 命令行选项 ]
Scancode-Toolkit 提供大量命令行选项，可用于自定义扫描的执行方式、输出格式以及扫描后插件等其他几个选项。这些选项目前还没有适当的文档来解释它们，只能通过“--help”或“-h”标记提供。此项目旨在编写说明以下内容的完整文档：
[ 1. “命令行中提供了所有可用选项”]
- 目标：通过命令行列出所有可能的选项。
- 基本概览：首先，我们讨论了默认扫描选项和输出示例。关于如何执行扫描的简短图片/说明。
在下文中，此默认行为可用作其他选项如何更改扫描和输出的参考。
我们会对这些内容进行详细介绍，并包含以下部分中介绍的信息。
[ 2. 启动版本控制结构 ]
- 目标：启动版本控制系统，以正确维护跨发布选项/API 和文档更改。
- 问题：目前，Wiki 和 ReadTheDocs 页面上的文档都是针对旧版本的，并且需要进行重大调整。
- 基本概览：在扫描码工具包中已更新/可以在版本中更新的部分包括
- 命令行选项
- API
- 文档（待开始） 命令行选项和 API 的版本和发行版中发生了变化，文档也必须跟上变化，否则会给用户带来很大的困惑。命令行实用程序 [ --help ] 已针对选项的任何更改进行了更新，并且可用于复制文档中的版本编号。
[ 3. 如何在不同情况下使用这些选项 ]
- 目标：本部分将简要介绍如何因不同原因使用 Scancode- Toolkit 的扫描结果，以及提供此类功能的 Scancode-Toolkit 选项。
- 基本概览：本部分提供了不同的用例场景示例，以及在这些场景中建议的选项。
- 注意：这一部分需要导师在输入 Scancode-Toolkit 以及给出相关指引方面提供重大帮助。
[ 4. 在 扫描和输出 中这些选项有何变化 ]
- 目标：本部分将简要介绍如何按不同原因使用 scancode- Toolkit 的扫描结果，以及提供此类功能的“关于代码”工具。
- 基本概览：这些选项可更改扫描的执行方式。 前面的部分 [ 1. 所有选项 ] 和本部分将比较所有选项对此默认场景带来的更改。
[ 5. 输出格式及其示例 ]
- 目标：本部分将简要介绍如何按不同原因使用 scancode- Toolkit 的扫描结果，以及提供此类功能的“关于代码”工具。
- 基本概述：Scancode-Tool 的标记用于指定生成扫描结果的不同输出格式。这些内容是-
本部分将 - 并详细说明了
- 提供输出格式示例。
- 提供了与输出格式及其用途对应的其他链接
- 扫描结果如何存储在输出文件中。 这里也提供了有关如何生成这些不同格式的页面的链接，相关内容将在 [ 2. 解释代码扫描的讨论]。
[ 6. Scancode 输出格式的商业用途 ]
- 目标：说明 Scancode 输出格式的商业用例 在 GSoD 创意列表中，我们提到了 Scancode 输出格式作为参考。本部分将实现相同的目的。
- 注意：这一部分需要导师提供关于 Scancode-Toolkit 的各种业务用例的输入和指向的大量帮助。
[ 7. 其他 aboutCode 项目如何使用这些输出进行更多分析 ]
- 目标：本部分将简要介绍如何按不同原因使用 scancode- Toolkit 的扫描结果，以及提供此类功能的“关于代码”工具。
- 基本概述：
- Scancode-Workbench 本部分介绍了如何通过桌面应用直观呈现结果，并提供了指向 scancode-workbench 文档的更多支持指南。如有必要，将向 scancode-workbench 添加所需的文档。
- Deltacode Deltacode 如何获取扫描码结果来确定两个代码库之间的文件级别差异。
[ 2. 重新组织 aboutCode 文档的结构 ]
此部分包含对关于代码文档的大量更改
[ 1. 版本控制 ]
在 [ 1. Scancode-Toolkit 命令行选项 -> 2. Initiate Versioning Structure] 命令行选项的版本控制问题。这同样适用于文档的其他部分，因为其中包含版本特定的命令/信息，否则会造成混淆。
[ 2. 设置文档标准和测试 ]
该文档已包含通过 Travis-CI 进行持续集成的测试，以便进行 Spinx-build（构建所有页面并在整个过程中检查 Sphinx 语法错误）和链接检查（检查文档中指向其他网页的所有链接）。（我在此拉取请求 17 中添加） 现在，它需要对重新结构化文本和其他标准中的特定 lint 请求进行更多检查。这可以通过 reStructuredtext-lint 来实现，但需要更多研究，并将作为 GSoD 项目的一部分完成。
[ 3. 添加“使用入门”部分 ]
本文将作为新手的入门部分，其中包含了最基本和最重要的文档的汇总，目的是帮助您开始了解关于代码项目。 每个关于代码项目都有此部分，包括 Scancode-Toolkit、Scancode-Workbench、Deltacode 等。
[ 4. 根据 4 个文档函数进行重构 ]
现有文档在 4 个文档功能中并未明确组织结构：教程、操作方法、参考和说明。我建议相应地设计这些框架，并根据需要添加更多信息/说明/指针。此幻灯片适用于所有 aboutCode 项目及其文档。下面这两个示例展示了我提议并想要在此项目中继续进行 Scancode-Toolkit 文档结构调整的两个示例。我们将在文档的其余部分进行类似的更改。
[ 5. 重组开发页面 (Scancode-Toolkit) ]
可以添加有关这些代码/API 的更多信息，使其更便于开发者使用。 您可以通过点击链接至 [ 2. 对上文“代码扫描]”部分的讨论。这会将扫描运作方式的说明关联到用于执行扫描的代码。 就像这些文件夹包含扫描码工具包的不同部分一样，您可以使用 API 来详细说明它们的具体用法，并附上有关扫描码运作方式的讨论。
- [ cluecode : 用于扫描许可、版权、网址、电子邮件的插件 ]
- [通用代码：辅助类和函数]
- [ extractcode : 提取不同的归档文件格式 ]
- [ formattedcode：不同输出文件格式的输出格式 ]
- [许可代码：许可检测代码 ]
- [ packagedcode：解析各种软件包格式 ]
- [ plugincode : 用于插件架构的类 ]
- [summarycode : summary scan on detected licenses ]
- [ textcode : 处理文本解析 ]
- [ 类型代码 : 处理文件类型确定 ]
- [ scancode : CLI and API to scancode, the core section ]
这一部分将在各个小节中相应地包含有关 scancode- Toolkit 这些部分的详细信息/API。 开发指南会显示在另一个页面或包含更小小节的其他部分。
[ 6. 调整常见问题解答页面的结构 (Scancode-Toolkit) ]
目前，“常见问题解答”页面上有一些问题可以得到更好的解答，因此应该按照单独的“操作方法”、“教程”和“参考文档”的结构进行构建。
- ScanCode 的工作原理是什么？ [ 2. 解释代码扫描 ] 的讨论，并且该部分将是一个完全独立的部分，其中会提供更多详细信息。
- 如何为增强型检测添加新的许可规则？ 我们之前在“改进现有方法指南”中已经讨论过此问题，我们会将相关文档移至该处。
- 如何添加新的许可检测规则？ 您可以将其制作成另一个“操作方法”博文，并加以详细说明。
- 如何开始进行开发？ 已经有单独的开发页面，信息有很多重叠。之前已经讨论了开发页面的结构。
- 发布新版本的步骤 可将上述内容转换为单独的“如何剪辑新版本”。
- 查找更多常见问题解答，这些问题可解答有关项目的一般性问题，而不属于“操作方法”/“教程”类别。