Progetto Arduino

Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.

Riepilogo del progetto

Organizzazione open source:

Arduino

Technical Writer:

AghaSaad04

Nome del progetto:

Documentare le librerie di terze parti

Durata del progetto:

Durata standard (3 mesi)

Project description

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

Documenta il funzionamento della libreria Documenta come migliorare le librerie per adattarle alle esigenze richieste

Ad esempio

La libreria NESController di Arduino deve essere ben documentata. Le sue funzionalità, la compatibilità, gli esempi e le applicazioni devono essere aggiunti nella documentazione per i relativi collaboratori. L'utilizzo è già menzionato nella documentazione, che può essere migliorata in misura maggiore. Nbiot-arduino è una libreria Arduino per accedere ai moduli NBIoT. La documentazione può essere migliorata estendendo le opzioni di utilizzo, creazione e test e debug. Devono essere inclusi anche gli esempi contenenti snippet di codice. La libreria Arduino più scelta, ArduinoJson, è ben documentata, con esempi che mostrano come utilizzarla in varie stazioni, il riferimento all'API contenente la descrizione di ogni classe e funzione, le domande frequenti che rispondono a quasi tutte le domande e l'assistente AduinoJson che scrive programmi per gli utenti. Analogamente, è necessario creare una documentazione approfondita per tutte le librerie di cui è necessario migliorare ed estendere la documentazione. Avendo esperienza nel campo dell'Internet of Things (IoT), ho le conoscenze di base sui microcontrollori. Ho dimestichezza con vari linguaggi di programmazione, tra cui Python, Java, C, C++, HTML5, JavaScript, C#. Sono molto interessato e disponibile a contribuire ad Arduino tramite le mie competenze di scrittura tecnica e le mie conoscenze di elettronica, microcontrollori e programmazione. Non vedo l'ora di saperne di più e di migliorare le mie competenze e conoscenze.

Userò Markdown per lo stile di tutti i miei scritti grazie alla sua sintassi facile da usare e all'ampio insieme 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

Offrirò più di 45 ore a settimana, ma in caso di imprevisti, compenserò queste ore nei fine settimana.Durante il periodo del vincolo della community, discuterò i mezzi di comunicazione e finalizzerò le riunioni settimanali, i mezzi e l'orario di queste riunioni con il mio mentore. Manterrò il mio mentore al corrente del mio lavoro e condividerò i dettagli del mio lavoro via email. Preferisco Team Viewer per comunicare, perché è facile da usare e offre molte funzionalità, come la condivisione delle schermate e così via.

Piani futuri

I miei piani per il futuro sono molto chiari, dopo il GSoD 2019. Continuerò a dare il mio contributo all'organizzazione anche in altri progetti. Cercherò di renderlo perfetto sotto tutti gli aspetti, dal punto di vista della documentazione a quello della sicurezza. Se avrò la possibilità, parteciperò sicuramente a qualsiasi riunione dell'organizzazione.

Termini e condizioni

Concordo solennemente che lavorerò nello stesso modo che ho spiegato in precedenza e, in caso di aborto spontaneo, verrò ritenuto responsabile. Sono consapevole dell'impegno richiesto per questo progetto e ti assicuro che sto dedicando l'intera stagione a questo progetto per offrirti il meglio.

Grazie per aver letto l'intera proposta. Non esitare a contattarmi per eventuali altre domande.