本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- 巴西加元
- 技术文档工程师：
- sahibkaur
- 项目名称：
- BRL-CAD 新手指南
- 项目时长：
- 标准时长（3 个月）
Project description
BRL-CAD 新手指南
项目摘要
该项目旨在为那些既刚接触 BRL-CAD 又是开源领域的新用户提供专属文档。
此项目的初衷
当我第一次访问 BRL-CAD 网站时，因为我刚开始接触开源和 BRL-CAD，一次搜索到的信息量让我感到不知所措。但在内心深处，我知道这里学到了很多东西。因此，我想为像我这样的新用户创建文档，以便充分了解这个社区并轻松上手。
进球数
此项目将面向新用户。因此，我的文档要实现的一些要点如下： 确保让新用户感到安心，因为本文档不仅面向刚刚接触 BRL-CAD 的新用户，而且也是开源领域的新用户。
为此，我将采取以下措施：
- 确保文件的 Flesch-Kincaid 分数至少保持在 50 以上。根据 Flesch-Kincaid 方法，得分越高，就越容易理解。您可以在线查看其可读性得分。
- 使用项目符号或编号列表，避免读者因冗长的段落而感到厌烦或分心。
- 使用较短的段落和句子，因为阅读和理解较长的句子需要相对较多的精力工作。
- 使用子标题拆分文本。 条理分明的文档：条理清晰的文档在引导新用户方面发挥着至关重要的作用。这样可以防止他们迷路，并让玩家知道他们的方向以及正在做什么。 为此，我制作了一份粗略的思维导图，以条理清晰的方式记录这份新手指南。
项目说明
此项目的重点是为新用户编写文档，以便他们上手使用这款软件。
下面的示例展示了我打算如何让文档更具描述性。
基本介绍： BRL-CAD（读作 be-are-el-cad）是一种建设性的固体几何图形 (CSG) 实体建模计算机辅助设计 (CAD)。它是一个功能强大的跨平台开源实体建模系统，适用于 3D 计算机辅助设计和图形可视化。 不知道如何操作？我们来详细了解一下。 开源：开源软件是一种具有源代码的软件，任何人都可以检查、修改和增强。BRL-CAD 是一款开源软件，欢迎您做出贡献，让 BRL-CAD 更上一层楼！ 计算机辅助设计 (CAD)：简而言之，CAD 就是使用计算机程序为实体对象创建二维或三维图形表示。 实体建模系统：BRL-CAD 侧重于实体建模 CAD。实体建模与其他几何建模的区别在于，它强调实体建模的准确性，能够完整描述 3D 空间。它会在内部和外部模拟对象。 构造实体几何 (CSG)：CSG 允许将复杂的模型表示为基元之间的一系列布尔运算。用于表示法的最简单的实心对象称为基元。 如需大致了解 CSG，请访问此处。
*如项目创意说明中所述： 文档至少会介绍基本安装、功能整体说明、BRL-CAD 建模原则、主要工具的基本用法、建模、导入/导出、分析和渲染。
排列的内容是简要说明文档中的每个部分。
- 基本安装：我会添加一个分步教程来引导您安装 BRL-CAD 软件和所需的屏幕截图。新手教程是新用户刚开始接触的好地方。我发现缺少的部分内容如下：
- 本初学员教程中的步骤没有项目符号或编号。提供分步教程并在每个步骤结束时提供屏幕截图，这样用户更容易被教程所吸引。
- 功能总体说明：此部分将涵盖 BRL-CAD 能够展示奇观的所有领域。图表化方式可以更好地吸引人们关注这一部分。
- BRL-CAD 的建模原则：这一部分需要进一步解释，因为用户充分理解这些建模原则后，就可以更好地了解 BRL-CAD。
- 主要工具的基本用法：在此部分中，我们将提供单独的教程，介绍主要工具及其基本用法。这些将是分步教程。
- 导出/导入：用户将了解几何图形转换库。BRL-CAD 最常见的用途之一是将几何图形从一种格式转换为另一种格式。在本部分，我们将讨论导出和导入转换器。
- 渲染：我们将介绍有关渲染的基础知识，并介绍我们的软件对渲染的需求。用户还将了解如何使用 BRL-CAD 渲染图片。
除此之外，我们还将关注以下几点：
- 文档开头部分会对此软件的内容有一个基本的了解。
- 用户如何与此开源社区联系；链接到 BRL-CAD zulip 聊天。
- 在抽象层面上，为文档增添一点幽默感，并要求新用户不要被大标题所用。我喜欢 BRL-CAD Wiki 主页中使用的同理心方法。
- 我们会提供一些屏幕截图，说明用户可以使用这款软件进行哪些精彩操作。
重大事件
7 月（提案审核期）
- 在浏览现有教程时，我会进一步熟悉该软件及其 Wiki 文档。
- 我们会对现有文档进行改进。
8 月 1 日至 8 月 7 日（社区凝聚）
- 与导师讨论该项目。
- 优化项目详情。
- 根据需要在里程碑中进行必要的更改。
8 月 8 日至 8 月 14 日
- 熟悉 Docbook XML
8 月 15 日至 8 月 21 日
- 编写“BRL-CAD 基本简介”文档
- 编写“基本安装”的分步教程
8 月 22 日至 8 月 27 日
- 探索 BRL-CAD 的各种功能，并将其与屏幕截图一起列出。
- 在单独的页面上说明各项功能。
8 月 28 日至 9 月 3 日
- 继续处理个别文档，了解各项功能。
9 月 4 日 - 9 月 10 日
- 研究建模原则。
- 解释所有建模原则。
9 月 11 日 - 9 月 17 日
- 了解主要工具的基本用法。
- 用于记录每种工具基本用法的候选清单。
9 月 18 日 - 9 月 24 日
- 记录每种工具的使用情况。
9 月 25 日至 10 月 1 日
- 利用建模功能，为教程创建一个实体模型，并同时编写一个草稿。
10 月 2 日至 10 月 8 日
- 改进根据模型估算转化草稿。
10 月 2 日至 10 月 8 日
- 学习导出和导入转换器。
10 月 9 日至 10 月 15 日
- 准备导出和导入文档。
- 开始渲染。
10 月 16 日至 10 月 22 日
- 记录渲染教程。
10 月 23 日 - 10 月 29 日
- 查看所有文档。
10 月 30 日至 11 月 5 日
- 处理 Docbook XML
11 月 6 日至 11 月 12 日
- 征求导师和其他社区成员的评价，并努力改进。
- 与导师讨论并做出最后的调整。
11 月 12 日至 11 月 22 日
- 讨论和更改流程。
- 对文档进行最后的润色。
关于我
我从上学时代起就开始写作。我会放学回家，写点自己的每一天，是什么让我的生活更美好，或一天变得更糟。我一直热衷于把自己犯的错误写下来，以及如何改进这些错误。
在接受网络设计师培训的过程中，我们需要将每天学到的内容写下来。我会记录我遇到的一些问题以及相应的解决方案。
作为一个人，我热衷于帮助他人。在上学和大学期间，我会先自己了解一些主题，然后向朋友们解释这些主题。 参加 GSoD 是绝佳的一步。作为一名作家，我能够为这个开源社区做出贡献，为世界各地的新用户带来更多的参与和帮助。