이 페이지에는 Google Season of Docs에서 수락된 기술 작문 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- 브라질 레알(CAD)
- 테크니컬 라이터:
- 사히브카우르
- 프로젝트 이름:
- 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에 기여하여 이전보다 더 나은 BRL-CAD를 만들 수 있습니다. CAD (Computer Aided Design): 간단히 말해 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일
- 문서북 XML 작업
11월 6일~11월 12일
- 멘토 및 다른 커뮤니티 회원의 리뷰를 요청하고 변경사항을 반영하세요.
- 멘토와 논의하고 최종적으로 변경합니다.
11월 12일~11월 22일
- 프로세스 논의 및 변경
- 문서에 대한 마지막 터치입니다.
내 정보
학교 시절부터 글쓰기를 시작했습니다. 학교에 가서 집에 돌아와서 하루를 쓴 글을 써버렸죠. 제가 범한 실수를 적고, 어떻게 하면 개선할 수 있을지 늘 궁금했습니다.
웹 디자이너로 교육을 받는 동안 매일 배우는 내용을 적어달라는 요청을 받았습니다. 제가 직면한 몇 가지 문제와 그에 대한 해결책을 문서로 남기고 싶습니다.
사람으로서 다른 사람을 돕기 위해 항상 최선을 다합니다. 학교와 대학 시절에는 제가 직접 주제를 이해한 후 친구들에게 몇 가지 주제를 설명하곤 했습니다. GSoD에 참여하는 것은 작가로서 전 세계 신규 사용자에게 더 흥미 있고 유용한 오픈소스 커뮤니티를 만드는 데 기여할 수 있는 훌륭한 단계입니다.