Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Arduino
- Pisarz techniczny:
- AghaSaad04
- Nazwa projektu:
- Biblioteki dokumentów innych firm
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Jestem doświadczonym redaktorem technicznym. Od ponad 3 lat piszę wysokiej jakości dokumentację oprogramowania, przewodniki użytkownika, podręczniki, analizę algorytmów, dokumentację projektów i publikację badawczą. W tym projekcie udokumentuję wszystkie biblioteki zewnętrzne. Staram się udokumentować tworzone i udostępnione przez Arduino biblioteki, tak aby deweloperzy mogli odkryć w pełni ich potencjał. Zrobię te zadania:
Dokumentowanie działania biblioteki Dokumentowanie, jak ulepszyć biblioteki tak, aby spełniały określone potrzeby
Na przykład
Biblioteka NESController w Arduino musi być dobrze udokumentowana. Jej funkcje, zgodność, przykłady i aplikacje należy dodać do dokumentacji dla współtwórców. Użycie zostało już wspomniane w dokumentacji, którą można w większym stopniu ulepszyć. Nbiot-arduino to biblioteka Arduino, która umożliwia dostęp do modułów NBIoT. Dokumentację można ulepszyć, rozszerzając opcje dotyczące użytkowania, kompilacji i testów oraz debugowania. Należy również uwzględnić przykłady zawierające fragmenty kodu. Biblioteka ArduinoJson, najbardziej popularna w serwisie Arduino, jest dobrze udokumentowana. Przykładami są przykłady wykorzystania biblioteki na różnych stacjach. Dokumentacja API zawierająca opis poszczególnych klas i funkcji, najczęstsze pytania na praktycznie każde pytanie oraz Asystent AduinoJsona, który tworzy programy dla użytkowników. Analogicznie należy przygotować szczegółową dokumentację wszystkich bibliotek, których dokumentację trzeba ulepszyć i rozszerzyć. Jako że mam doświadczenie w dziedzinie internetu rzeczy (IoT), mam podstawową wiedzę o mikrokontrolerach. Mam biegłość w różnych językach programowania, m.in. Python, Java, C, C++, HTML5, JavaScript i C#. Bardzo interesuję się Arduino i chcę wnieść swój wkład w rozwój Arduino, dzieląc się swoimi umiejętnościami technicznymi w zakresie pisania oraz wiedzą na temat elektroniki, mikrokontrolerów i programowania. Chętnie poszerzę swoją wiedzę i umiejętności.
Do stylizacji całego tekstu będę używać języka Markdown ze względu na jego łatwą w użyciu składnię i obszerny zestaw funkcji.
Szablon
Jest to jeden z szablonów, których możesz używać w dokumentacji. Można ją modyfikować oraz dodawać nowe sekcje zgodnie z wymaganiami dokumentu.
$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: project@google-groups.com
License
-------
This section will tell about the license of the project.
This project is licensed under the BSD.
Nakład czasu i komunikacja
Będę poświęcać ponad 45 godzin tygodniowo, ale na wypadek, gdyby coś się stało, odpłacę za te godziny w weekendy.W czasie trwania więzi ze społecznością omówię sposoby komunikacji i ustalę z mentorem cotygodniowe spotkania, sposoby i godziny takich spotkań. Będę na bieżąco informować mentora o swojej pracy i przesyłać do niego szczegóły swojej pracy. Do komunikacji wolę wyświetlać zespół, ponieważ jest łatwy w użyciu i ma wiele funkcji, takich jak udostępnianie ekranu.
Przyszłe plany
Moje plany na przyszłość są bardzo jasne po GSoD 2019. Będę nadal pomagać organizacji w innych projektach. Postaram się go udoskonalić pod każdym względem, od perspektywy dokumentacji po bezpieczeństwo. Z pewnością wezmę udział w każdym spotkaniu organizacji, jeśli tylko będzie to możliwe.
Warunki korzystania z usługi
Przyjmuję do wiadomości, że będę pracować w sposób opisany powyżej, a w przypadku jakiegokolwiek poronienia poniesiem odpowiedzialność. Rozumiem, że ten projekt wymaga wysiłku. Poświęcę go cały sezon, aby móc jak najlepiej go przygotować.
Dziękujemy za przeczytanie całej propozycji. Jeśli masz dodatkowe pytania, skontaktuj się ze mną.