Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Arduino
- Pisarz techniczny:
- AghaSaad04
- Nazwa projektu:
- Dokumentowanie bibliotek innych firm
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Jestem doświadczonym autorem tekstów technicznych. Od ponad 3 lat piszę wysokiej jakości dokumentację oprogramowania, przewodniki użytkownika, podręczniki, analizy algorytmów, dokumentację projektów i artykuły naukowe. W ramach tego projektu udokumentuję wszystkie biblioteki innych firm. Staram się dokumentować biblioteki stworzone przez Arduino i udostępnione przez innych, aby deweloperzy mogli w pełni wykorzystać ich potencjał. Wykonam te zadania:
Opisz działanie biblioteki. Opisz, jak ulepszyć biblioteki, aby spełniały wymagania.
Na przykład
Biblioteka NESController z Arduino musi być dobrze udokumentowana. W dokumentacji dla współtwórców należy dodać informacje o funkcjach, kompatybilności, przykładach i aplikacji. Sposób korzystania z tych funkcji jest już opisany w dokumentacji, ale można go jeszcze udoskonalić. Nbiot-arduino to biblioteka Arduino do obsługi modułów NBIoT. Jej dokumentację można ulepszyć, rozszerzając opcje wykorzystania, kompilacji i testowania oraz debugowania. Należy też uwzględnić przykłady zawierające fragmenty kodu. Biblioteka ArduinoJson, która ma najwięcej gwiazdek w Arduino, jest dobrze udokumentowana. W dokumentacji znajdują się przykłady pokazujące, jak używać biblioteki w różnych stacjach, odniesienie do interfejsu API zawierające opis każdej klasy i funkcji, odpowiedzi na praktycznie wszystkie pytania oraz asystent ArduinoJson, który pisze programy dla użytkowników. Podobnie należy dokładnie udokumentować wszystkie biblioteki, których dokumentacja wymaga ulepszenia i rozszerzenia. Mam doświadczenie w zakresie Internetu Rzeczy (IoT) i podstawową wiedzę o mikrokontrolerach. Świetnie znam różne języki programowania, w tym Python, Java, C, C++, HTML5, JavaScript i C#. Jestem bardzo zainteresowany i chętny do wniesienia wkładu w Arduino dzięki moim umiejętnościom pisania technicznego i wiedzy na temat elektroniki, mikrokontrolerów i programowania. Chcę się więcej nauczyć i doskonalić swoje umiejętności oraz wiedzę.
Do stylizacji wszystkich moich tekstów będę używać Markdowna ze względu na jego łatwą w użyciu składnię i bogaty zestaw funkcji.
Szablon
To jeden z szablonów, których można użyć do utworzenia dokumentacji. Można go modyfikować i 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.
Czas i komunikacja
Będę poświęcać ponad 45 godzin tygodniowo, ale w razie nieszczęśliwego wypadku będę nadrabiać te godziny w weekendy.W trakcie okresu budowania więzi ze społecznością będę omawiać sposoby komunikacji i ustalać z moim mentorem harmonogram spotkań, ich formę i czas trwania. Będę na bieżąco informować mentora o mojej pracy, a szczegóły pracy prześlę mu e-mailem. Do komunikacji wolę używać aplikacji Team Viewer, ponieważ jest ona łatwa w użyciu i zawiera wiele funkcji, takich jak udostępnianie ekranu.
Przyszłe plany
Moje plany na przyszłość są bardzo jasne po GSoD 2019. Będę też nadal wspierać organizację w ramach innych projektów. Postaram się, aby był on idealny pod każdym względem, od dokumentacji po bezpieczeństwo. Jeśli tylko będzie taka możliwość, na pewno wezmę udział w każdym spotkaniu tej organizacji.
Warunki korzystania z usługi
Poważnie oświadczam, że będę pracować w sposób opisany powyżej i w przypadku jakiegokolwiek błędu ponoszę za to odpowiedzialność. Rozumiem, że ten projekt wymaga poświęcenia. Zapewniam, że poświęcam na niego cały sezon, aby wykonać jak najlepszą pracę.
Dziękujemy za przeczytanie całej oferty. Jeśli masz jeszcze jakieś pytania, skontaktuj się ze mną.