このページは Cloud Translation API によって翻訳されました。

BRL-CAD プロジェクト

このページには、Google シーズンの Google ドキュメントで承認されたテクニカルライティングプロジェクトの詳細が記載されています。

プロジェクトの概要

オープンソースの組織:: ブラジルレアル - カナダドル
テクニカルライター:: sahibkaur
プロジェクト名:: BRL-CAD 初心者向けガイド
プロジェクトの期間:: 標準の長さ（3 か月）

プロジェクトの説明

BRL-CAD 初心者向けガイド

プロジェクト概要

このプロジェクトは、BRL-CAD を初めて使用するユーザーだけでなく、オープンソースのユーザーも対象として、専用のドキュメントを作成することを目的としています。

このプロジェクトの目的

BRL-CAD のウェブサイトを初めて訪れたとき、オープンソースと BRL-CAD の経験が浅いため、一度に大量の情報に圧倒されました。しかし深く、ここで学ぶべきことがたくさんあると思いました。そこで、私のような新規ユーザー向けのドキュメントを作成して、このコミュニティから多くのことを学び、安心して始められるようにしたいと考えました。

目標

このプロジェクトは新規ユーザーをターゲットにします。私のドキュメントで達成したい点は次のとおりです。新規ユーザーに安心感を持たせるため: このドキュメントは、BRL-CAD やオープンソースを初めて利用する新規ユーザーを対象としています。

目的は次のとおりです。

ドキュメントの Flesch-Kincaid スコアが 50 以上になっていることを確認してください。フレッシュ・キンケイド法では、スコアが高いほど、作品が理解しやすくなります。読みやすさスコアをオンラインで確認できます。
長い段落で退屈したり気が散ったりしないよう、箇条書きや番号付きリストを使用します。
長い文を読んで理解するには、比較的精神的な労力が必要になるため、段落や文は短くします。
小見出しを使用してテキストを分割します。適切な構造のドキュメント: 適切な構造のドキュメントは、新規ユーザーを導くうえで重要な役割を果たします。これにより、生徒が道に迷うのを防ぎ、どこに向かっていて何をしているのかを知ることができます。これを実現するために、この初心者向けガイドを体系的に文書化するのに役立つ大まかなマインドマップを作成しました。

プロジェクトの説明

このプロジェクトでは、新規ユーザーがソフトウェアを使いこなせるようにドキュメントを作成することに重点を置いています。

以下は、ドキュメントをよりわかりやすくする例です。

概要: BRL-CAD（be-are-el-cad と発音）は、建設的立体幾何学（CSG）ソリッドモデリングコンピュータ支援設計（CAD）です。3D コンピュータ支援設計とグラフィック可視化のための、パワフルなクロスプラットフォーム対応のオープンソースソリッドモデリングシステムです。頭がよくわからない場合は、詳しく見ていきましょう。オープンソース: オープンソースソフトウェアは、誰でも検査、変更、拡張できるソースコードを備えたソフトウェアです。オープンソースソフトウェアの BRL-CAD は、BRL-CAD の改善に貢献していただき、ありがとうございます。コンピュータ支援設計（CAD）: 簡単に言えば、CAD はコンピュータプログラムを使用して、物理的なオブジェクトを 2 次元または 3 次元のグラフィック表現を作成することです。ソリッドモデリングシステム: 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 日～ 7 日（コミュニティの絆）

プロジェクトについてメンターと話し合う。
プロジェクトの詳細を調整する。
マイルストーンに必要な変更を加えます（必要な場合）。

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 日

「Working on Modeling Principles」。
モデリングの原則をすべて説明します。

9 月 11 日～ 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 に参加したことは、私がライターとして、このオープンソースコミュニティを世界中の新規ユーザーにとってより魅力的で役に立つものにするために貢献できる素晴らしい一歩です。