The beginning of the documentation will have a basic understanding of what this software is all about.Users will also get to know how to render images in BRL-CAD.Īpart from that, the focus is also on following points: Rendering: We will cover the basics of rendering and the need for it in our software.Under this section, we discuss export and import converters. One of the most common uses of BRL-CAD is to convert geometry from one format to another. Export/Import: Users will get to know about Geometry Conversion Library.Basic usage of major tools: Under this, we will have separate tutorials of the major tools and their basic usage.BRL-CAD’s modeling principles: This part will require more explanation because the user can better understand BRL-CAD once they get a solid grasp on these modeling principles.A diagrammatic approach will be a better way to grab attention towards this part. An overall description of capabilities: This section will contain all the areas where BRL-CAD has the power to show wonders.Having a step-by-step tutorial with a screenshot at the end of each step makes it more likely for the user to get hooked to the tutorial. The steps of this beginner’s tutorial are not bulleted or numbered.The tutorial for newbie is a nice place for new users to begin with. Basic Installation: I will add a step by step tutorial to install BRL-CAD software along with required screenshots.Lined up are brief intros to how I will cover each part in the documentation. The documentation will minimally cover basic installation, an overall description of capabilities, of BRL-CAD’s modeling principles, basic usage of major tools, modeling, import/export, analysis, and rendering. *As mentioned in the project idea description: To understand CSG on a fundamental level, visit here. The simplest solid objects used for the representation are called primitives. It simulates an object both internally and externally.Ĭonstructive Solid Geometry (CSG): CSG allows to represent complex models as a series of Boolean operations between primitives. Solid modeling is distinguished from other forms of geometric modeling by an emphasis on being physically accurate, fully describing 3D space. Solid modeling system: BRL-CAD focuses on solid modeling CAD. BRL-CAD being an open-source software welcomes you to contribute and make BRL-CAD better than before!Ĭomputer Aided Design (CAD): In simple words, CAD is the use of computer programs to create two or three dimensional graphical representation of physical objects. Open-source: Open source software is a software with source code that anyone can inspect, modify, and enhance. It is a powerful, cross-platform, open-source solid modeling system for 3D computer-aided design and graphic visualization.Ĭan’t get your head around it? Let’s break it down. Given below is an example of how I intend to make documentation more descriptive.īRL-CAD (pronounced be-are-el-cad) is a constructive solid geometry (CSG) solid modeling computer-aided design (CAD). This project focuses on writing documentation for new users to get their hands on this software. To achieve this I have built a rough mind map which can help us document this beginner’s guide in an organized way. It prevents them from getting lost and, let them know where they are heading and what they are doing. Well-structured documentation: Well-structured documentation plays a crucial role in guiding new users. Use shorter paragraphs and sentences because it requires comparatively more mental work to read and understand longer sentences.Use bulleted or numbered lists so that readers do not get bored or distracted by long paragraphs.You can check its readability score online. According to the Flesch-Kincaid method, the higher the score, the easier the piece is to understand. Make sure to keep the Flesch-Kincaid score of the document at least above 50.To ensure new users feel at ease: Since this documentation is for new users not only new to BRL-CAD but also new to open-source. So, following are some points my documentation aims to achieve: So, I wanted to create documentation for new users like me to get a lot out of this community and feel at ease to get started with. But deep down, I knew there is a lot to learn here. When I first visited the BRL-CAD website, as I was new to open-source and BRL-CAD, I got overwhelmed by the amount of information at one go. This project aims at creating documentation dedicated to users who are not only new to BRL-CAD but also new to open-source. Project summary Open source organization: BRL-CAD Technical writer: sahibkaur Project name: A Beginner's Guide To BRL-CAD Project length: Standard length (3 months) Project descriptionĪ Beginner's Guide To BRL-CAD Project Abstract This page contains the details of a technical writing project accepted for
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |