BRL-CAD-Projekt

Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.

Projektzusammenfassung

Open-Source-Organisation:
BRL-CAD
Technischer Redakteur:
Sahibkaur
Projektname:
Erste Schritte mit BRL-CAD
Projektdauer:
Standarddauer (3 Monate)

Projektbeschreibung

Erste Schritte mit BRL-CAD

Projektzusammenfassung

Ziel dieses Projekts ist die Erstellung einer Dokumentation für Nutzer, die nicht nur mit BRL-CAD, sondern auch mit Open-Source-Programmen noch nicht vertraut sind.

Warum dieses Projekt?

Als ich die BRL-CAD-Website zum ersten Mal besucht habe, war ich aufgrund der Menge an Informationen überwältigt, da ich noch nicht mit Open Source und BRL-CAD gearbeitet habe. Aber tief im Inneren wusste ich, dass es hier viel zu lernen gibt. Deshalb wollte ich eine Dokumentation für neue Nutzende wie mich erstellen, um diese Community bestmöglich zu nutzen und sich sicher zu fühlen.

Tore

Dieses Projekt wird auf neue Nutzer ausgerichtet. Hier sind einige Punkte, die ich mit meiner Dokumentation erreichen möchte: Um Nutzern ein sicheres Gefühl zu vermitteln: Diese Dokumentation richtet sich nicht nur an neue Nutzer, die mit BRL-CAD noch nicht vertraut sind, sondern auch für Open-Source-Nutzer.

Um dies zu erreichen, werde ich:

  • Achten Sie darauf, dass die Flesch-Kincaid-Punktzahl des Dokuments mindestens 50 beträgt. Nach der Flesch-Kincaid-Methode ist das Stück leichter zu verstehen, je höher die Punktzahl ist. Sie können den Lesbarkeitsindex online prüfen.
  • Verwenden Sie Listen mit Aufzählungszeichen oder nummerierte Listen, damit sich die Leser nicht durch lange Absätze langweilen oder ablenken.
  • Verwenden Sie kürzere Absätze und Sätze, da es vergleichsweise mehr mentale Arbeit erfordert, längere Sätze zu lesen und zu verstehen.
  • Gliedern Sie den Text durch Zwischenüberschriften. Gut strukturierte Dokumentation: Eine gut strukturierte Dokumentation spielt eine entscheidende Rolle bei der Anleitung neuer Nutzer. Es verhindert, dass sie sich verirren und informieren sie darüber, wohin sie gehen und was sie tun. Um dieses Ziel zu erreichen, habe ich eine grobe Mindmap erstellt, die uns helfen kann, diesen Leitfaden für Anfänger übersichtlich zu dokumentieren.

Projektbeschreibung

Dieses Projekt konzentriert sich auf das Schreiben einer Dokumentation für neue Nutzende, damit diese Software in die Hände bekommen.

Unten sehen Sie ein Beispiel dafür, wie ich die Dokumentation aussagekräftiger gestalten möchte.

Grundlegende Einführung: BRL-CAD (ausgesprochen be-are-el-cad) ist ein CSG-Modell (computer-aided Design, CAD). Es ist ein leistungsstarkes, plattformübergreifendes Open-Source-System zur soliden Modellierung für computergestützte 3D-Designs und grafische Visualisierung. Sie haben Schwierigkeiten, sich daran zu orientieren? Keine Sorge, wir erklären dir, was das ist. Open Source: Open-Source-Software ist eine Software mit Quellcode, den jeder einsehen, ändern und verbessern kann. Da BRL-CAD eine Open-Source-Software ist, freuen wir uns, wenn du mitmachst und BRL-CAD noch besser machen kannst. Computer Aided Design (CAD): Einfach ausgedrückt ist CAD die Verwendung von Computerprogrammen zur Erstellung einer zwei- oder dreidimensionalen grafischen Darstellung physischer Objekte. Solid-Modellierungssystem: Bei BRL-CAD liegt der Schwerpunkt auf der physikalischen Präzision und der vollständigen Beschreibung des 3D-Raums. Sie simuliert ein Objekt sowohl intern als auch extern. Konstruktive Solid Geometry (CSG): Mit CSG können komplexe Modelle als Reihe von booleschen Operationen zwischen Primitiven dargestellt werden. Die einfachsten Körperobjekte, die für die Darstellung verwendet werden, werden Primitive genannt. Grundlegende Informationen zu CSG findest du hier.

*Wie bereits in der Beschreibung der Projektidee erwähnt: In der Dokumentation geht es nur um die grundlegende Installation, eine allgemeine Beschreibung der Funktionen, die Modellierungsprinzipien von BRL-CAD, die grundlegende Verwendung der wichtigsten Tools sowie um Modellierung, Import/Export, Analyse und Rendering.

Anbei finden Sie eine kurze Einführung in die einzelnen Abschnitte der Dokumentation.

  • Basisinstallation: Ich füge eine Schritt-für-Schritt-Anleitung zur Installation der BRL-CAD-Software zusammen mit den erforderlichen Screenshots hinzu. Das Tutorial für Neueinsteiger ist ein guter Ausgangspunkt für neue Nutzer. Einige der Dinge, die mir fehlen, sind:
  • Die Schritte in dieser Anleitung für Anfänger sind nicht nummeriert oder nummeriert. Mit einem Schritt-für-Schritt-Tutorial mit einem Screenshot am Ende jedes Schritts steigt die Wahrscheinlichkeit, dass die Nutzenden sich für das Tutorial begeistern.
  • Allgemeine Beschreibung der Funktionen: In diesem Abschnitt werden alle Bereiche aufgeführt, in denen BRL-CAD Wunder darstellen können. Ein schematischer Ansatz ist eine bessere Möglichkeit, die Aufmerksamkeit auf diesen Teil zu lenken.
  • Modellierungsprinzipien von BRL-CAD: Dieser Teil erfordert eine genauere Erläuterung, da der Nutzer BRL-CAD besser verstehen kann, sobald er diese Modellierungsprinzipien gut verstanden hat.
  • Grundlegende Verwendung der wichtigsten Tools: Hier finden Sie separate Anleitungen für die wichtigsten Tools und ihre grundlegende Verwendung. Das sind Schritt-für-Schritt-Anleitungen.
  • Exportieren/Importieren: Die Nutzer machen sich mit der Geometry Conversion Library vertraut. BRL-CAD wird häufig verwendet, um Geometrie von einem Format in ein anderes zu konvertieren. In diesem Abschnitt werden Export- und Importkonverter erläutert.
  • Rendering: Wir behandeln die Grundlagen des Renderings und die Notwendigkeit, es in unserer Software zu verwenden. Außerdem erfahren sie, wie Bilder in BRL-CAD gerendert werden.

Außerdem liegt der Schwerpunkt auf folgenden Punkten:

  • Zu Beginn dieser Dokumentation erhalten Sie ein grundlegendes Verständnis des Inhalts dieser Software.
  • Informationen dazu, wie Nutzer mit dieser Open-Source-Community in Kontakt treten können; Link zum Zulip-Chat in BRL-CAD
  • Auf abstrakter Ebene sollte die Dokumentation etwas humorvoll sein und die neuen Nutzer bitten, sich nicht durch große Wörter entmutigen zu lassen. Mir gefiel der empathische Ansatz auf der Hauptseite des BRL-CAD-Wiki.
  • Dort finden Sie Screenshots von einigen erstaunlichen Dingen, die Nutzer mit dieser Software tun können.

Meilensteine

Juli (Zeitraum der Angebotsüberprüfung)

  • Ich werde mich mit der Software und den zugehörigen Wiki-Dokumenten vertrauter machen, während ich die vorhandenen Anleitungen durcharbeite.
  • Ich werde an den vorhandenen Dokumenten Verbesserungen vornehmen.

1.–7. August (Community-Beziehung)

  • Gespräche mit beratenden Personen über das Projekt.
  • Die Projektdetails verfeinern.
  • Nehmen Sie bei Bedarf die erforderlichen Änderungen an den Meilensteinen vor.

8.–14. August

  • Docbook-XML kennenlernen

15.–21. August

  • Dokumentation für die „Basic Introduction to BRL-CAD“ schreiben
  • Schreiben einer Schritt-für-Schritt-Anleitung für „Grundlegende Installation“

22.–27. August

  • Wir erkunden verschiedene Möglichkeiten von BRL-CAD und listen sie zusammen mit Screenshots auf.
  • Erkläre einzelne Funktionen auf einer separaten Seite.

28. August bis 3. September

  • Arbeiten Sie weiter an einzelnen Dokumenten, um Funktionen zu erhalten.

4.–10. September

  • Modellierungsprinzipien.
  • Erläuterung aller Modellierungsprinzipien.

11.–17. September

  • Arbeiten Sie an der grundlegenden Verwendung der wichtigsten Tools.
  • Listen Sie Ideen auf, um die grundlegende Verwendung der einzelnen Tools zu dokumentieren.

18.–24. September

  • Die Nutzung der einzelnen Tools dokumentieren.

25. September bis 1. Oktober

  • Arbeiten Sie an der Modellierung, um ein solides Modell für das Tutorial zu erstellen, und schreiben Sie zusammen einen Entwurf.

2.–8. Oktober

  • Modellierungsentwurf verbessern

2.–8. Oktober

  • Sie lernen, wie man Export- und Importunternehmen ausführt.

9.–15. Oktober

  • Bereiten Sie den Export und Import von Dokumenten vor.
  • Beginnen Sie mit dem Rendering.

16.–22. Oktober

  • Rendering-Anleitung dokumentieren

23.–29. Oktober

  • Ich prüfe alle Dokumente.

30. Oktober bis 5. November

  • Docbook-XML bearbeiten

6.–12. November

  • Bitten Sie Mentoren und andere Community-Mitglieder um Rezensionen und arbeiten Sie an den Veränderungen.
  • Mit Mentoren sprechen und endgültige Änderungen vornehmen

12.–22. November

  • Diskussions- und Änderungsprozess.
  • Letzte Infos zur Dokumentation

Über mich

Ich schreibe seit meiner Schulzeit. Ich kam von der Schule nach Hause und schrieb alles über meinen Tag. Was hat meinen Tag besser oder schlechter gemacht? Ich habe immer gerne meine Fehler aufgeschrieben und wie ich sie verbessern kann.

Während meiner Ausbildung als Webdesigner wurden wir gebeten, aufzuschreiben, was wir täglich lernen. Ich würde einige der Probleme, mit denen ich konfrontiert war, und die Lösung dafür dokumentieren.

Als Person gebe ich immer mein Bestes, um anderen zu helfen. Während der Schulzeit habe ich meinen Freunden einige Themen erklärt, nachdem ich diese Themen selbst verstanden hatte. Die Teilnahme an GSoD ist ein großartiger Schritt, den ich als Autorin dazu beitragen kann, diese Open-Source-Community für neue Nutzer auf der ganzen Welt interessanter und hilfreicher zu machen.