Projekt BRL-CAD

Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.

Podsumowanie projektu

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

Opis projektu

BRL-CAD – przewodnik dla początkujących

Podsumowanie projektu

Ten projekt ma na celu opracowanie dokumentacji przeznaczonej dla użytkowników, którzy nie tylko zaczynają przygodę z BRL-CAD, ale też rozpoczynają korzystanie z oprogramowania open source.

Dlaczego ten projekt

Gdy pierwszy raz odwiedziłam stronę BRL-CAD, ponieważ dopiero zaczynałam przygodę z modelem open source i BRL-CAD, przytłoczyła mnie ilość informacji dostępnych za jednym razem. Ale w głębszej wierze zdałam sobie sprawę, że muszę się tu wiele nauczyć. Postanowiłam więc przygotować dokumentację dla nowych użytkowników, takich jak ja, aby poczuć się pewniej i sprawić, że zaczną z niej korzystać.

Gole

Ten projekt będzie kierowany do nowych użytkowników. Oto kilka punktów, do których chciałabym dotrzeć z dokumentacją: Aby zapewnić nowym użytkownikom poczucie swobody: ta dokumentacja jest przeznaczona nie tylko dla nowych użytkowników BRL-CAD, ale też nowych użytkowników na licencji open source.

Aby to osiągnąć:

  • Pamiętaj, aby zachować wynik Flescha-Kincaida dla dokumentu na poziomie co najmniej 50. Według metody Flescha-Kincaida im wyższy wynik, tym łatwiej jest zrozumieć fragment. Wynik czytelności możesz sprawdzić online.
  • Używaj list punktowanych lub numerowanych, aby użytkownicy nie nudzili się ani nie rozpraszali długich akapitów.
  • Używaj krótszych akapitów i zdań, ponieważ czytanie i rozumienie dłuższych zdań wymaga trochę więcej pracy umysłowej.
  • Użyj podtytułów, aby podzielić tekst. Uporządkowana dokumentacja: odpowiednio uporządkowana dokumentacja odgrywa kluczową rolę w przyciąganiu nowych użytkowników. Dzięki temu nie zgubią się w końcu i poinformują, dokąd zmierzają i co robią. W tym celu stworzyłem ogólną mapę myśli, która pomoże nam udokumentować podręcznik dla początkujących w zorganizowany sposób.

Opis projektu

Ten projekt koncentruje się na opracowaniu dokumentacji dla nowych użytkowników, która pozwoli im zapoznać się z tym oprogramowaniem.

Poniżej znajduje się przykład tego, w jaki sposób chcę wzbogacić dokumentację.

Wprowadzenie: BRL-CAD (wymawiane jako „be-are-el-cad”) to konstrukcja wspomagana komputerowo do modelowania brył (CSG). Jest to zaawansowany, wieloplatformowy system open source do modelowania brył stałych do projektowania graficznego i wspomaganego komputerowo 3D. Nie możesz go ominąć? Przeanalizujmy wszystko po kolei. Oprogramowanie open source to oprogramowanie z kodem źródłowym, które każdy może przeglądać, modyfikować i ulepszać. BRL-CAD jako oprogramowanie open source zachęca do współtworzenia i ulepszania BRL-CAD. Projektowanie wspomagane komputerowo (CAD): Krótko mówiąc, CAD polega na wykorzystaniu programów komputerowych do tworzenia dwu- lub trójwymiarowego graficznego odwzorowywania obiektów fizycznych. System modelowania brył: BRL-CAD koncentruje się na modelowaniu bryłowym CAD. Modelowanie brył wyróżnia się od innych form modelowania geometrycznego tym, że jest precyzyjne i w pełni opisywanie przestrzeni 3D. Symuluje obiekt zarówno wewnętrznie, jak i zewnętrznie. Constructive Solid Geometry (CSG): CSG umożliwia reprezentowanie złożonych modeli jako serii operacji na wartościach logicznych między nimi. Najprostsze obiekty stałe używane do reprezentacji są nazywane elementami podstawowymi. Aby poznać podstawowe informacje na temat CSG, zajrzyj tutaj.

*Jak wspomniano w opisie projektu: Dokumentacja będzie w minimalnym stopniu obejmować podstawową instalację, ogólny opis możliwości, zasady modelowania BRL-CAD, podstawowe zastosowania głównych narzędzi, modelowanie, import/eksport, analizę i renderowanie.

Przedstawimy w nim pokrótce, jak omówię każdą część dokumentacji.

  • Instalacja podstawowa: dodam szczegółowy samouczek instalacji oprogramowania BRL-CAD ze zrzutami ekranu. Samouczek dla początkujących jest dobrym rozwiązaniem dla początkujących użytkowników. Oto niektóre z nich:
  • Kroki tego samouczka dla początkujących nie są punktowane ani numerowane. Szczegółowy samouczek ze zrzutem ekranu na końcu każdego kroku zwiększa prawdopodobieństwo, że użytkownik przyciągnie go do samouczka.
  • Ogólny opis możliwości: w tej sekcji znajdziesz wszystkie obszary, w których BRL-CAD może pokazywać cuda. Lepszym sposobem na przyciągnięcie uwagi do tej części będzie diagram.
  • Zasady modelowania BRL-CAD: ta część będzie wymagała bardziej szczegółowych wyjaśnień, ponieważ po zdobyciu odpowiedniej wiedzy na temat modelowania BRL-CAD użytkownik będzie mógł lepiej zrozumieć model BRL-CAD.
  • Podstawowe zasady korzystania z głównych narzędzi: tutaj znajdziesz oddzielne samouczki przedstawiające główne narzędzia i ich podstawowe funkcje. Będą to samouczki krok po kroku.
  • Eksportuj/importuj: użytkownicy poznają bibliotekę konwersji geometrycznych. Jednym z najczęstszych zastosowań formatu BRL-CAD jest konwertowanie geometrii z jednego formatu na inny. W tej sekcji omawiamy konwersje eksportu i importu.
  • Renderowanie: omówimy podstawy renderowania i jego potrzebę w naszym oprogramowaniu. Użytkownicy dowiedzą się też, jak renderować obrazy w BRL-CAD.

Skupiamy się również na następujących kwestiach:

  • Na początku dokumentacji wyjaśniamy, do czego służy to oprogramowanie.
  • Jak użytkownicy mogą nawiązać kontakt z tą społecznością open source; link do czatu BRL-CAD zulip.
  • Na poziomie abstrakcyjnym zadbanie o to, aby dokumentacja była trochę zabawna, i zachęcenie nowych użytkowników, by nie zniechęcali się wielkimi słowami. Podobało mi się empatyczne podejście stosowane na stronie głównej wiki BRL-CAD.
  • Będą tam zrzuty ekranu pokazujące, co użytkownicy mogą robić za pomocą tego oprogramowania.

Kamienie milowe

Lipiec (okres sprawdzania oferty pakietowej)

  • W trakcie przeglądania istniejących samouczków będę lepiej poznać oprogramowanie i dostępne w nim dokumenty wiki.
  • Wprowadzę ulepszenia w istniejących dokumentach.

1–7 sierpnia (powiązanie społeczności)

  • Porozmawiaj z mentorami na temat projektu.
  • Doprecyzowywanie szczegółów projektu
  • W razie potrzeby wprowadź niezbędne zmiany w etapach milowych.

8–14 sierpnia

  • Poznaj kod XML Docbooka

15–21 sierpnia

  • Opracowanie dokumentacji „Basic Introduction to BRL-CAD”
  • Tworzenie szczegółowego samouczka dotyczącego „instalacji podstawowej”

22–27 sierpnia

  • Omówienie różnych możliwości BRL-CAD i ich wymienienie wraz ze zrzutami ekranu.
  • Objaśnij poszczególne funkcje na osobnej stronie.

28 sierpnia – 3 września

  • Kontynuuj pracę nad poszczególnymi dokumentami, aby poznać możliwości.

4–10 września

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

11–17 września

  • Naucz się podstawowych korzystania z najważniejszych narzędzi.
  • Utwórz listę pomysłów na podstawowe informacje o korzystaniu z 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 utworzyć solidny model na potrzeby samouczka i napisać obok niego wersję roboczą.

2–8 października

  • Ulepsz wersję roboczą modelowania.

2–8 października

  • Analiza konwersji eksportu i importu

9–15 października

  • Przygotuj dokumenty do eksportowania i importowania.
  • Zacznij pracę nad renderowaniem.

16–22 października

  • Dokumentuję samouczek renderowania.

23–29 października

  • Sprawdzenie wszystkich dokumentów.

30 października – 5 listopada

  • Praca nad kodem XML dokumentu Docbook

6–12 listopada

  • Poproś mentorów oraz innych członków społeczności o opinie i popracuj nad zmianami.
  • Rozmowy z mentorami i wprowadzanie ostatecznych zmian.

12–22 listopada

  • Proces dyskusji i wprowadzania zmian.
  • Wprowadzam ostatnie poprawki w dokumentacji.

O mnie

Piszę już od czasów szkoły. Wracałam ze szkoły i piszę do wszystkiego o swoim dniu, o tym, co na niego wpływało. Zawsze chciałam spisywać swoje błędy i jak je poprawić.

Podczas szkolenia z projektowania stron internetowych poproszono nas o spisanie wszystkiego, czego się uczymy na co dzień. Udokumentowałam kilka napotkanych problemów i ich rozwiązania.

Jako człowiek zawsze staram się pomagać innym. W szkole i na uniwersytecie wyjaśniałam niektóre tematy znajomym, gdy samodzielnie je zgłębiałam. Uczestnictwo w programie GSoD jest wspaniałym krokiem, na którym ja, jako twórczyni, mogę przyczynić się do tego, by ta społeczność open source była bardziej atrakcyjna i pomocna dla nowych użytkowników z całego świata.