이 페이지에는 Google 시즌의 Docs에 승인된 기술 글쓰기 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- BRL-CAD
- 기술 문서 작성자:
- 사히브카우르
- 프로젝트 이름:
- BRL-CAD 초보자 가이드
- 프로젝트 길이:
- 표준 기간 (3개월)
Project description
BRL-CAD 초보자 가이드
프로젝트 개요
이 프로젝트는 BRL-CAD뿐만 아니라 오픈소스도 처음 사용하는 사용자를 위한 문서를 만드는 것을 목표로 합니다.
이 프로젝트의 목적
오픈소스와 BRL-CAD를 처음 접했을 때 BRL-CAD 웹사이트를 처음 방문한 저는 한꺼번에 제공되는 방대한 정보에 압도되었습니다. 하지만 속으로는 여기서 배울 것이 많다는 것을 알고 있었습니다. 그래서 저와 같은 신규 사용자가 이 커뮤니티를 최대한 활용하고 안심하고 시작할 수 있도록 문서를 작성하고자 했습니다.
목표
이 프로젝트는 신규 사용자를 타겟팅합니다. 따라서 다음은 문서에서 달성하고자 하는 몇 가지 목표입니다. 신규 사용자가 안심할 수 있도록 지원: 이 문서는 BRL-CAD뿐만 아니라 오픈소스도 처음 접하는 신규 사용자를 대상으로 합니다.
이를 위해 다음과 같은 조치를 취할 것입니다.
- 문서의 Flesch-Kincaid 점수가 50 이상이어야 합니다. 플레쉬-킨케이드 방법에 따르면 점수가 높을수록 작품을 이해하기 쉽습니다. 온라인에서 가독성 점수를 확인할 수 있습니다.
- 긴 단락으로 인해 독자가 지루해하거나 주의를 분산시키지 않도록 글머리기호 또는 번호 목록을 사용하세요.
- 긴 문장을 읽고 이해하는 데 비교적 더 많은 정신적 노력이 필요하므로 짧은 단락과 문장을 사용하세요.
- 부제목을 사용하여 텍스트를 구분합니다. 체계적인 문서: 체계적인 문서는 신규 사용자를 안내하는 데 중요한 역할을 합니다. 이를 통해 사용자가 길을 잃지 않고 어디로 가고 있는지, 무엇을 하고 있는지 알 수 있습니다. 이를 위해 이 초보자 가이드를 체계적으로 문서화하는 데 도움이 되는 대략적인 마인드맵을 만들었습니다.
프로젝트 설명
이 프로젝트는 신규 사용자가 이 소프트웨어를 사용해 볼 수 있도록 문서를 작성하는 데 중점을 둡니다.
아래는 문서를 더 설명적으로 만드는 방법의 예입니다.
기본 소개: BRL-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를 더 잘 이해할 수 있으므로 이 부분에는 더 많은 설명이 필요합니다.
- 주요 도구의 기본 사용: 여기에서는 주요 도구와 기본 사용에 관한 별도의 튜토리얼을 제공합니다. 단계별 튜토리얼입니다.
- 내보내기/가져오기: 사용자가 도형 변환 라이브러리에 관해 알아봅니다. BRL-CAD의 가장 일반적인 용도 중 하나는 도형을 한 형식에서 다른 형식으로 변환하는 것입니다. 이 섹션에서는 내보내기 및 가져오기 변환기를 설명합니다.
- 렌더링: 렌더링의 기본사항과 소프트웨어에서의 필요성을 다룹니다. 또한 이미지를 BRL-CAD로 렌더링하는 방법도 배울 수 있습니다.
그 외에도 다음 사항에 중점을 둡니다.
- 문서의 시작 부분에서는 이 소프트웨어의 기본 사항을 알 수 있습니다.
- 사용자가 이 오픈소스 커뮤니티와 소통하는 방법. BRL-CAD zulip 채팅 링크
- 추상적인 수준에서 문서를 약간 유머러스하게 만들고 신규 사용자에게 어려운 단어에 낙담하지 말라고 요청합니다. BRL-CAD 위키 기본 페이지에서 사용된 공감적인 접근 방식이 마음에 들었습니다.
- 이 소프트웨어를 사용하여 사용자가 할 수 있는 놀라운 작업의 스크린샷이 포함됩니다.
목표
7월 (제안서 검토 기간)
- 기존 튜토리얼을 진행하면서 소프트웨어와 위키 문서에 더 익숙해지겠습니다.
- 기존 문서를 개선하겠습니다.
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에 참여하는 것은 제가 작가로서 이 오픈소스 커뮤니티를 전 세계 신규 사용자에게 더 매력적이고 유용한 커뮤니티로 만드는 데 기여할 수 있는 멋진 발걸음입니다.