Progetto BRL-CAD

Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.

Riepilogo del progetto

Organizzazione open source:
BRL-CAD
Technical writer:
sahibkaur
Nome progetto:
Guida introduttiva alla valuta BRL-CAD
Durata del progetto:
Durata standard (3 mesi)

Project description

Guida introduttiva alla valuta BRL-CAD

Estratto del progetto

Questo progetto ha lo scopo di creare una documentazione dedicata agli utenti che non sono solo neofiti di BRL-CAD, ma anche che non hanno familiarità con l'open source.

Perché questo progetto

Quando ho visitato per la prima volta il sito web di BRL-CAD, non sapevo ancora cosa fare con l'open source e BRL-CAD, sono stato sopraffatto dalla quantità di informazioni in una volta sola. Ma nel profondo, sapevo che c'è molto da imparare. Quindi, volevo creare documentazione per i nuovi utenti come me per ottenere molto da questa community e sentirsi a proprio agio a iniziare.

Gol

Questo progetto avrà come target nuovi utenti. Quindi, di seguito sono riportati alcuni punti che la mia documentazione mira a raggiungere: Per garantire che i nuovi utenti si sentano a proprio agio: questa documentazione è destinata ai nuovi utenti non solo di BRL-CAD, ma anche di open source.

Per raggiungere questo obiettivo:

  • Assicurati di mantenere il punteggio Flesch-Kincaid del documento almeno superiore a 50. Secondo il metodo Flesch-Kincaid, più alto è il punteggio, più facile è capire l'opera. Puoi controllare il suo punteggio di leggibilità online.
  • Utilizza elenchi puntati o numerati in modo che i lettori non si annoino o si distraggano a causa dei lunghi paragrafi.
  • Usa frasi e paragrafi più brevi perché richiede un lavoro relativamente più mentale per leggere e capire frasi più lunghe.
  • Utilizza i sottotitoli per suddividere il testo. Documentazione ben strutturata: una documentazione ben strutturata gioca un ruolo fondamentale nel guidare nuovi utenti. Impedisce loro di perdersi e fai sapere loro dove si stanno dirigendo e cosa stanno facendo. Per ottenere questo risultato, ho creato una mappa mentale approssimativa che può aiutarci a documentare questa guida per principianti in modo organizzato.

Descrizione progetto

Questo progetto è incentrato sulla scrittura di documentazione per consentire ai nuovi utenti di acquistare questo software.

Di seguito è riportato un esempio di come intendo rendere la documentazione più descrittiva.

Introduzione di base: BRL-CAD (pronunciato be-are-el-cad) è un progetto CAD per la modellazione dei solidi costruttivi a geometria solida (CSG). È un potente sistema di modellazione dei solidi open source multipiattaforma per la progettazione 3D computerizzata e la visualizzazione grafica. Non riesci a orientarti? Esaminiamo la questione nel dettaglio. Open source: il software open source è un software con codice sorgente che chiunque può esaminare, modificare e migliorare. BRL-CAD è un software open source per dare il tuo contributo e migliorare BRL-CAD. Computer Aided Design (CAD): in parole semplici, CAD è l'uso di programmi per computer per creare rappresentazioni grafica bidimensionali o tridimensionali di oggetti fisici. Sistema di modellazione dei solidi: BRL-CAD si concentra sulla modellazione dei solidi CAD. La modellazione dei solidi si distingue dalle altre forme di modellazione geometrica per l'enfasi sulla precisione fisica e sulla descrizione completa dello spazio 3D. Simula un oggetto sia internamente che esternamente. Geometria solida costruttiva (CSG): la tecnologia CSG consente di rappresentare modelli complessi come una serie di operazioni booleane tra primitive. Gli oggetti solidi più semplici utilizzati per la rappresentazione sono chiamati primitive. Per una comprensione più approfondita di CSG, visita questa pagina.

*Come menzionato nella descrizione dell'idea di progetto: La documentazione riguarderà almeno l'installazione di base, una descrizione generale delle funzionalità, i principi di modellazione di BRL-CAD, l'utilizzo di base dei principali strumenti, la modellazione, l'importazione/esportazione, l'analisi e il rendering.

Qui trovi brevi introduzioni su come tratterò ogni parte della documentazione.

  • Installazione di base: aggiungerò un tutorial dettagliato per installare il software BRL-CAD insieme agli screenshot richiesti. Il tutorial per i nuovi utenti è un buon punto di partenza per i nuovi utenti. Ecco alcune delle cose che mi mancano:
  • I passaggi di questo tutorial per principianti non sono puntati o numerati. Avere un tutorial passo passo con uno screenshot alla fine di ogni passaggio aumenta le probabilità che l'utente si interessi al tutorial.
  • Una descrizione generale delle funzionalità: questa sezione conterrà tutte le aree in cui BRL-CAD ha il potere di mostrare meraviglie. Un approccio schematico sarà un modo migliore per attirare l'attenzione verso questa parte.
  • Principi di modellazione di BRL-CAD: questa parte richiederà ulteriori spiegazioni perché l'utente può capire meglio BRL-CAD dopo aver acquisito una solida conoscenza di questi principi.
  • Utilizzo di base degli strumenti principali: nell'ambito di questa presentazione, ci saranno tutorial separati sugli strumenti principali e sul loro utilizzo di base. Questi saranno tutorial passo passo.
  • Esporta/Importa: gli utenti impareranno a conoscere la Libreria di conversione Geometry. Uno degli utilizzi più comuni di BRL-CAD è la conversione della geometria da un formato a un altro. In questa sezione parleremo degli utenti che hanno completato l'esportazione e l'importazione.
  • Rendering: ci occuperemo delle nozioni di base relative al rendering e della sua esigenza nel nostro software. Gli utenti impareranno anche come eseguire il rendering delle immagini in BRL-CAD.

Inoltre, ci concentriamo anche sui seguenti punti:

  • All'inizio della documentazione verrà fornita una conoscenza di base di questo software.
  • In che modo gli utenti possono entrare in contatto con questa community open source: link alla chat Zullip BRL-CAD.
  • A livello astratto, rendi la documentazione un po' spiritosa e chiedi ai nuovi utenti di non farsi scoraggiare dalle parolacce. Mi è piaciuto l'approccio empatico utilizzato nella pagina principale del wiki BRL-CAD.
  • Contiene screenshot di alcune cose straordinarie che gli utenti possono fare utilizzando questo software.

Traguardi

Luglio (periodo di revisione della proposta)

  • Durante le esercitazioni esistenti, acquisirò maggiore dimestichezza con il software e i relativi documenti wiki.
  • Apporterò miglioramenti ai documenti esistenti.

1° agosto - 7 agosto (legami di comunità)

  • Parlare con i mentori del progetto.
  • Perfezionare i dettagli del progetto.
  • Apporta le modifiche necessarie agli obiettivi (se necessario).

8-14 agosto

  • Acquisisci familiarità con Docbook XML

15-21 agosto

  • Scrittura della documentazione per "Introduzione di base a BRL-CAD"
  • Scrivi un tutorial passo passo per "Installazione di base"

22-27 agosto

  • Esplorazione di varie funzionalità di BRL-CAD e elenco insieme a screenshot.
  • Spiega le singole funzionalità in una pagina separata.

28 agosto-3 settembre

  • Continua a lavorare sui singoli documenti per conoscere le funzionalità.

4-10 settembre

  • al lavoro sui principi della creazione di modelli.
  • Spiegare tutti i principi della definizione del modello.

11-17 settembre

  • Lavorare sull'utilizzo di base degli strumenti principali.
  • Elencare le idee per documentare l'utilizzo di base di ciascuno strumento.

18-24 settembre

  • Documentare l'utilizzo di ogni strumento.

25 settembre-1° ottobre

  • Lavora sulla modellazione per creare un modello solido per il tutorial e, allo stesso tempo, scrivi una bozza.

2-8 ottobre

  • Migliora la bozza di definizione del modello.

2-8 ottobre

  • Studio dei convertitori di esportazione e importazione.

9-15 ottobre

  • Prepara l'esportazione e l'importazione dei documenti.
  • Inizia a lavorare sul rendering.

16-22 ottobre

  • Documentare il tutorial sul rendering.

23 - 29 ottobre

  • Sto esaminando tutti i documenti.

30 ottobre-5 novembre

  • Lavorare sul file XML del documento

6-12 novembre

  • Chiedi recensioni a mentori e altri membri della community e lavora ai cambiamenti.
  • Discutere con i mentori e apportare modifiche finali.

12-22 novembre

  • Discussione e processo di modifica.
  • Dare l'ultimo tocco alla documentazione.

Informazioni su di me

Mi occupo della scrittura fin dai tempi della scuola. Tornavo a casa da scuola e scrivevo tutto sulla mia giornata, cosa migliorava o peggiorava la mia giornata. Ho sempre voluto annotare gli errori che commettevo e come posso migliorarli.

Durante la mia formazione come web designer, ci è stato chiesto di scrivere quello che impariamo ogni giorno. Documentrei alcuni dei problemi che ho affrontato e la soluzione.

Come persona, ho sempre dato il mio meglio per aiutare gli altri. A scuola e al college, spiegavo alcuni argomenti ai miei amici dopo averli compresi io. Partecipare a GSoD è uno splendido passo attraverso il quale io, come scrittore, posso contribuire a rendere questa community open source più coinvolgente e utile per i nuovi utenti di tutto il mondo.