Projekt BRL-CAD

Ta strona zawiera szczegóły projektu technicznego do pisania w sezonie Dokumentów Google.

Podsumowanie projektu

Organizacja open source:
BRL-CAD
Pisarz techniczny:
sahibkaur
Nazwa projektu:
Przewodnik dla początkujących po BRL-CAD
Długość projektu:
Standardowa długość (3 miesiące)

Opis projektu

Przewodnik dla początkujących po BRL-CAD

Streszczenie projektu

Celem tego projektu jest opracowanie dokumentacji przeznaczonej dla użytkowników, którzy nie tylko po raz pierwszy korzystają z BRL-CAD, ale także rozpoczynają korzystanie z modelu open source.

Dlaczego ten projekt

Gdy po raz pierwszy odwiedziłem stronę BRL-CAD, byłem nowicjuszem w zakresie oprogramowania open-source i BRL-CAD, więc przytłoczyła mnie ilość informacji. Jednak w głąb serca wiedziałem, że mam jeszcze wiele do nauczenia. Chciałem więc utworzyć dokumentację dla nowych użytkowników, takich jak ja, aby mogli oni w pełni korzystać z tej społeczności i bez obaw zacząć korzystać z jej funkcji.

Cele

Ten projekt będzie kierowany na nowych użytkowników. Oto kilka celów, które przyświecały mi podczas tworzenia dokumentacji: Aby nowi użytkownicy czuli się swobodnie: ta dokumentacja jest przeznaczona nie tylko dla nowych użytkowników BRL-CAD, ale też dla nowych użytkowników oprogramowania open source.

Aby to osiągnąć:

  • Upewnij się, że indeks czytelności Flescha dokumentu jest wyższy niż 50. Według metody Flescha-Kincaid im wyższa wartość, tym łatwiej jest zrozumieć tekst. Możesz sprawdzić jego czytelność online.
  • Używaj list punktowanych lub numerowanych, aby nie nudzić czytelników ani nie rozpraszać ich długimi akapitami.
  • Korzystaj z krótszych akapitów i zdań, ponieważ czytanie i rozumienie dłuższych zdań wymaga więcej wysiłku umysłowego.
  • Używaj podtytułów, aby podzielić tekst. Odpowiednia struktura dokumentacji: kluczowa jest odpowiednia struktura dokumentacji, która pomaga nowym użytkownikom. Dzięki temu nie gubią się i wiedzą, dokąd zmierzają i co robią. Aby to osiągnąć, stworzyłem ogólną mapę myśli, która pomoże nam uporządkować ten przewodnik dla początkujących.

Opis projektu

Ten projekt skupia się na tworzeniu dokumentacji dla nowych użytkowników, którzy chcą zapoznać się z tym oprogramowaniem.

Poniższy przykład pokazuje, jak zamierzam ujednolicić dokumentację.

Wprowadzenie: BRL-CAD (czytane jako be-are-el-cad) to komputerowe wspomaganie projektowania (CAD) z wykorzystaniem geometrii zbiorczej (CSG). Jest to potężny, wieloplatformowy system modelowania brył typu open source do projektowania wspomaganego komputerowo i wizualizacji graficznej. Nie możesz tego zrozumieć? Przeanalizujmy wszystko po kolei. Oprogramowanie open source: oprogramowanie open source to oprogramowanie, którego kod źródłowy może być sprawdzany, modyfikowany i ulepszany przez każdego. BRL-CAD to oprogramowanie typu open source, dlatego zapraszamy do udziału w rozwijaniu tego projektu. Projektowanie wspomagane komputerowo (CAD): w najprostszym ujęciu CAD to tworzenie dwu- lub trójwymiarowych graficznych przedstawień rzeczywistych obiektów za pomocą programów komputerowych. System modelowania bryłowego: BRL-CAD koncentruje się na modelowaniu bryłowym. Modelowanie bryłowe odróżnia się od innych form modelowania geometrycznego tym, że jest fizycznie dokładne i w pełni opisuje przestrzeń 3D. Symuluje obiekt zarówno wewnętrznie, jak i zewnętrznie. Konstrukcyjna geometria Solid (CSG): umożliwia przedstawianie złożonych modeli w postaci serii operacji logicznych między elementami podstawowymi. Najprostsze obiekty bryłowe używane do reprezentacji nazywane są prymitywami. Aby poznać podstawowe zagadnienia związane z CSG, kliknij tutaj.

*Jak wspomniano w opisie projektu: dokumentacja będzie zawierać informacje o podstawowej instalacji, ogólny opis możliwości, zasad modelowania w BRL-CAD, podstawowe informacje o korzystaniu z głównych narzędzi, modelowaniu, importowaniu/eksportowaniu, analizie i renderowaniu.

Wstępy to krótkie wprowadzenia do poszczególnych części dokumentacji.

  • Podstawowa instalacja: dodam samouczek krok po kroku dotyczący instalacji oprogramowania BRL-CAD wraz z wymaganymi zrzutami ekranu. Nowi użytkownicy mogą zacząć od samouczka dla początkujących. Oto kilka rzeczy, których brakuje:
  • Kroki w tym samouczku dla początkujących nie są oznaczone. Samouczek krok po kroku z ekranem podsumowania na końcu każdego kroku zwiększa prawdopodobieństwo, że użytkownik będzie chciał go obejrzeć.
  • Ogólny opis możliwości: Ta sekcja będzie zawierać wszystkie obszary, w których BRL-CAD może pokazać cuda. Aby zwrócić uwagę na tę część, lepiej użyć diagramu.
  • Zasady modelowania BRL-CAD: ta część będzie wymagała więcej wyjaśnień, ponieważ użytkownik będzie mógł lepiej zrozumieć BRL-CAD, gdy już dobrze pozna te zasady modelowania.
  • Podstawowe informacje na temat najważniejszych narzędzi: w ramach tych kursów dostępne będą osobne samouczki dotyczące głównych narzędzi i ich podstawowego wykorzystania. Będą to samouczki krok po kroku.
  • Eksportowanie/importowanie: użytkownicy dowiedzą się więcej o bibliotece konwersji geometrii. BRL-CAD jest najczęściej używany do konwertowania geometrii z jednego formatu na inny. W tej sekcji omawiamy eksportowanie i importowanie konwerterów.
  • Renderowanie: omówimy podstawy renderowania i potrzebę korzystania z niego w naszym oprogramowaniu. Użytkownicy dowiedzą się też, jak renderować obrazy w BRL-CAD.

W związku z tym należy wspomnieć o tych kwestiach:

  • Na początku dokumentacji znajdziesz podstawowe informacje o tym oprogramowaniu.
  • Jak użytkownicy mogą nawiązać kontakt z tą społecznością open source; link do czatu BRL-CAD w Zulip.
  • Na poziomie abstrakcyjnym: uczynić dokumentację nieco zabawną i poprosić nowych użytkowników, aby nie zniechęcali się do niej przez skomplikowane słownictwo. Spodobało mi się empatyczne podejście na stronie głównej wiki BRL-CAD.
  • Znajdą się na nim zrzuty ekranu z niezwykłymi czynnościami, które można wykonać za pomocą tego oprogramowania.

Cele

Lipiec (okres sprawdzania propozycji)

  • Poznam lepiej oprogramowanie i dokumentację w Wiki, korzystając z dostępnych samouczków.
  • Wprowadzę ulepszenia w dotychczasowych dokumentach.

1 sierpnia – 7 sierpnia (tworzenie relacji w społeczności)

  • Rozmowa z mentorami na temat projektu
  • doprecyzowanie szczegółów projektu,
  • W razie potrzeby wprowadź niezbędne zmiany w etapach.

8–14 sierpnia

  • Zapoznaj się z formatem XML Docbook

15–21 sierpnia

  • pisanie dokumentacji „Basic Introduction to BRL-CAD”
  • napisanie samouczka krok po kroku „Podstawowa instalacja”

22–27 sierpnia

  • Poznawanie różnych funkcji BRL-CAD i wypisywanie ich wraz ze zrzutami ekranu.
  • Opisz poszczególne funkcje na osobnej stronie.

28 sierpnia – 3 września

  • kontynuować pracę nad poszczególnymi dokumentami w celu uzyskania dostępu do funkcji;

4–10 września

  • Praca nad zasadami modelowania.
  • Wyjaśnienie wszystkich zasad modelowania.

11–17 września

  • Zajmij się podstawowym korzystaniem z głównych narzędzi.
  • Utwórz listę pomysłów, aby udokumentować podstawowe wykorzystanie każdego narzędzia.

18–24 września

  • dokumentowanie sposobu korzystania z każdego narzędzia;

25 września – 1 października

  • Pracuj nad modelowaniem, aby stworzyć solidny model do samouczka i napisz jego wersję roboczą.

2–8 października

  • Ulepsz wersję roboczą modelowania.

2–8 października

  • Zapoznaj się z konwerterami eksportu i importu.

9–15 października

  • Przygotuj dokumenty do eksportowania i importowania.
  • Rozpocznij renderowanie.

16–22 października

  • Dokumentacja samouczka dotyczącego renderowania.

23–29 października

  • Sprawdzanie wszystkich dokumentów.

30 października – 5 listopada

  • Praca z plikiem XML Docbook

6–12 listopada

  • Poproś mentorów i innych członków społeczności o opinie, a następnie wprowadzaj zmiany.
  • Rozmowy z mentorami i wprowadzanie ostatecznych zmian.

12–22 listopada

  • Dyskusja i proces zmian.
  • Wprowadzanie ostatnich poprawek w dokumentacji.

O mnie

Pisanie interesowało mnie od czasów szkolnych. Wracałam ze szkoły i pisałam wszystko, co wydarzyło się tego dnia, co sprawiło, że był lepszy lub gorszy. Zawsze starałam się zapisywać popełniane błędy i sposoby ich poprawiania.

Podczas szkolenia na projektanta stron internetowych proszono nas, abyśmy codziennie zapisywali to, czego się uczyliśmy. Opiszę niektóre napotkane problemy i sposoby ich rozwiązania.

Zawsze staram się jak najlepiej pomagać innym. W szkole i na studiach wyjaśniałam niektóre tematy znajomym, gdy już je zrozumiałam. Uczestnictwo w programie GSoD to dla mnie wspaniały krok, dzięki któremu jako autor mogę przyczynić się do zwiększenia zaangażowania i pomocy nowych użytkowników na całym świecie w tej społeczności open source.