Progetto Arduino

Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per Google Season of Docs.

Riepilogo del progetto

Organizzazione open source:

Arduino

Technical writer:

AghaSaad04

Nome progetto:

Librerie di documenti di terze parti

Durata del progetto:

Durata standard (3 mesi)

Project description

Sono un Technical Writer esperto. Scrivo documentazione software di alta qualità, guide per l'utente, manuali, analisi degli algoritmi, documentazione di progetti, articoli di ricerca da più di tre anni. In questo progetto, documenterò tutte le librerie di terze parti. Il mio obiettivo è documentare le librerie realizzate da Arduino e quelle che hanno contribuito in modo che tutto il loro potenziale sia esposto agli sviluppatori. Effettuerò le seguenti attività:

Documentare il funzionamento della libreria Documentare come migliorare le librerie per soddisfare le esigenze richieste

Ad esempio

La libreria NESController di Arduino deve essere davvero ben documentata. Le funzionalità, la compatibilità, gli esempi e le applicazioni devono essere aggiunti alla documentazione per i collaboratori. L'utilizzo è già menzionato nella documentazione, che può essere migliorata maggiormente. Nbiot-arduino è una libreria Arduino per accedere ai moduli NBIoT. La sua documentazione può essere migliorata estendendo le opzioni di utilizzo, build e test e debug. È necessario includere anche gli esempi contenenti snippet di codice. La libreria più speciale di Arduino, ArduinoJson, è ben documentata e contiene esempi che mostrano come utilizzare la libreria in varie stazioni, Riferimento API contenente la descrizione di ogni classe e funzione, FAQ che risponde a praticamente ogni domanda e l'Assistente AduinoJson, che scrive programmi per i suoi utenti, sono inclusi nella documentazione. Analogamente, è necessario fornire una documentazione approfondita per tutte le librerie la cui documentazione deve essere migliorata ed estesa. Avendo esperienza nel campo dell'Internet of Things (IoT), ho una conoscenza di base dei microcontrollori. Conosce vari linguaggi di programmazione tra cui Python, Java, C, C++, HTML5, JavaScript e C#. Sono molto interessato e disponibile a contribuire ad Arduino attraverso le mie competenze tecniche di scrittura e le conoscenze in materia di elettronica, micro-controller, programmazione. Non vedo l'ora di saperne di più e di migliorare le mie competenze e conoscenze.

Utilizzerò Markdown per applicare stili a tutta la mia scrittura grazie alla sua sintassi facile da usare e all'ampio set di funzionalità.

Modello

Questo è uno dei modelli che possono essere utilizzati per la documentazione. Può essere modificato ed è possibile aggiungere nuove sezioni in base ai requisiti del documento.

$projectName/Library Name
--------
In this section, I will give background information of the library, 
what does this library use, on what languages and framework it is based on, 
what are the dependencies of this library/project where it will be used

Features
--------
I will add features of the project here like
- this library creates connection between server and client
- Make things faster

Installation
------------
In this section I will add the installation procedure and dependencies that 
needs to be installed.
Install $project by running:
install project

Contribute
----------
For the contributors, I will add this section in documentation.
- Issue Tracker: github.com/$project/$project/issues
- Source Code: github.com/$project/$project

Support
-------
This section can also be added
If you are having issues, please let us know.
We have a mailing list located at: [e-mail]

License
-------
This section will tell about the license of the project.
This project is licensed under the BSD.

Impegno in termini di tempo e comunicazione

Darò più di 45 ore alla settimana, ma in caso di eventuali contrattempi, compenserò queste ore nei fine settimana.Durante il periodo di legame con la comunità, parlerò dei mezzi di comunicazione e organizzerò gli incontri settimanali, i mezzi e il tempo per quegli incontri con il mio mentore. Manterrò aggiornato il mio mentore sul mio lavoro e condividerò i dettagli del lavoro via email. Preferisco il Team Viewer per la comunicazione, poiché è facile da usare con molte funzionalità come gli schermi di condivisione ecc.

Piani futuri

I miei piani per il futuro sono molto chiari, dopo il GSoD’19. Continuerò a contribuire all'organizzazione anche in altri progetti. Cercherò di renderlo perfetto sotto ogni aspetto, dal punto di vista della documentazione al punto di vista della sicurezza. Sicuramente parteciperò a qualsiasi riunione dell'organizzazione, se mai ne avrò l'opportunità.

Termini e condizioni

Accetto solennemente che lavorerò come ho spiegato sopra e che sarò ritenuto responsabile in caso di aborto spontaneo. Capisco la dedizione necessaria per questo progetto, ti assicuro che dedicherò la mia intera stagione a questo progetto in modo da poter offrire il miglior lavoro possibile.

Grazie per aver letto l'intera proposta. Non esitare a contattarmi in caso di ulteriori domande.