本页面包含 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。
- 主要工具的基本使用：我们将针对主要工具及其基本使用分别提供教程。这些教程将采用分步方式。
- 导出/导入：用户将了解 Geometry Conversion Library。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 日
- 讨论和更改流程。
- 对文档进行最后的完善。
关于我
我从上学起就喜欢写作。我放学回家后，写下每天的生活点滴，记录生活的点点滴滴。我一直很乐意写下自己犯的错误以及如何改进。
在成为一名 Web 设计师的培训期间，我们被要求每天记下学到的内容。我会记录遇到的一些问题以及相应的解决方案。
我一直都尽力帮助他人。在中学和大学期间，我会在自己理解某些主题后，向朋友解释这些主题。 参加 GSoD 是一次绝佳的机会，作为一名编辑，我可以通过它为这个开源社区做出贡献，让它变得更加富有吸引力，并为世界各地的新用户提供更多帮助。