本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- Arduino
- 技術文件撰寫者：
- AghaSaad04
- 專案名稱：
- 文件第三方程式庫
- 專案長度：
- 標準長度 (3 個月)
Project description
我是經驗豐富的技術文件撰寫專員。我撰寫了超過三年的優質軟體說明文件、使用手冊、演算法分析、專案說明文件和研究論文。 在這個專案中，我會記錄所有第三方程式庫。我會記錄 Arduino 製作及貢獻的圖書館，向開發人員展現所有潛能。我會完成下列工作：
記錄程式庫的運作情形 說明文件如何改善程式庫，使其符合所需需求
範例
Arduino 的 NESController 程式庫確實需要妥善記錄。其功能、相容性、範例、應用程式應加入其貢獻者的說明文件中。說明文件中已提及使用方式，但又可以進行更多調整。Nbiot-arduino 是用於存取 NBIoT 模組的 Arduino 程式庫。如要改進說明文件，可以擴充「使用情形」、「建構和測試」及「偵錯選項」。(也應包含內含程式碼片段的範例)。 Arduino 中最已加星號的程式庫 ArduinoJson 當中詳盡記錄為範例，說明瞭如何在各個車站使用程式庫、包含各類別和函式說明的 API 參考資料、幾乎所有問題的答案，以及 AduinoJson Assistant 則提供使用者編寫程式的相關範例。同樣地，對於需要改善及擴充說明文件的所有程式庫，都應該提供詳盡的說明文件。 我曾在物聯網 (IoT) 領域使用過微控制器，並具備微控制器的基本知識。我熟悉多種程式設計語言，包括 Python、Java、C、C++、HTML5、JavaScript、C#。我非常有興趣，也願意透過自己的技術寫作技巧、電子元件、微控制器及程式設計相關知識，為 Arduino 貢獻一己之力。我希望瞭解更多相關資訊，並增進自己的技能和知識。
我將使用 Markdown 設定所有文章的樣式，因為這個程式碼簡單好用，且具備豐富功能。
範本
這是可用於說明文件的範本之一。如有需要，你可以根據文件規定修改內容，並新增區段。
$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.
投入時間與溝通
我每週會舉辦超過 45 小時的訓練，但如有任何疏失，我會補足週末的時數。在社群聯繫期間，我將討論每週會議方式，以及與導師召開每週會議的時間和時間。我會隨時讓導師掌握最新的工作資訊，並透過電子郵件將我的工作詳細資料分享給導師。我偏好使用團隊檢視器來溝通，因為透過分享螢幕畫面等許多功能相當容易使用。
未來計畫
2019 年 GSoD 之後，我未來的計畫非常清楚，我也會繼續對其他專案中的機構做出貢獻。從說明文件到安全性的角度，我都會盡力在各方面達到完美的結果。只要有機會，我一定會參加機構的任何會議。
條款及細則
我非常同意我會用上述方式工作，如有任何流產，我必須負責。我瞭解這項專案必須盡善盡職責，我保證會把整季專案投入這個專案，這樣我才能盡力提供最佳工作。
感謝您閱讀整份提案。如有其他問題，歡迎與我聯絡。