本頁將詳細說明 Google Season of Docs 接受的技術文件寫作專案。
專案摘要
- 開放原始碼組織：
- Arduino
- 技術撰稿人：
- AghaSaad04
- 專案名稱：
- 說明第三方程式庫
- 專案長度：
- 標準長度 (3 個月)
Project description
我是經驗豐富的技術文件撰稿人。我已撰寫優質的軟體文件、使用者指南、手冊、演算法分析、專案文件、研究論文超過三年。在這個專案中，我會記錄所有第三方程式庫。我的目標是記錄 Arduino 打造並貢獻的程式庫，讓開發人員充分發揮其潛力。我會完成下列工作：
記錄程式庫的運作方式 文件如何改善程式庫，使其符合必要需求
例如
Arduino 的 NESController 程式庫確實需要完善的文件。該項目的功能、相容性、範例及應用程式，應新增至文件貢獻者的說明文件。說明文件中已提到用法，但仍有許多進步空間。Nbiot-arduino 是用於存取 NB-IoT 模組的 Arduino 程式庫。您可以擴充「Usage」、「Build & Test」、「Debug Options」等，改善說明文件。也應該附上內含程式碼片段的範例。 Arduino 最受歡迎的程式庫 ArduinoJson 有完整的說明文件，其中包含許多範例，說明如何在各個站點使用該程式庫。此外，說明文件中還提供 API 參考資料，內含各個類別和函式的說明；常見問題解答，提供幾乎所有問題的解答；以及 ArduinoJson 助理，可為使用者編寫程式。同樣地，對於需要改善和擴充說明文件的所有程式庫，也應提供深入的說明文件。我在物聯網 (IoT) 領域具備豐富經驗，對微控制器有基本瞭解。我精通各種程式設計語言，包括 Python、Java、C、C++、HTML5、JavaScript 和 C#。我對 Arduino 非常感興趣，並願意運用我的技術寫作技能和電子、微控制器、程式設計知識，為 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 小時以上，但如果發生任何意外，我會在週末補上這些時間。在社群連結期，我會與導師討論溝通方式，並確定每週的會議、會議方式和時間。我會持續向導師更新工作進度，並透過電子郵件與導師分享工作詳細資料。我會建議使用 Team Viewer 進行通訊，因為它很容易使用，而且提供許多功能，例如共用螢幕畫面等。
未來計畫
在 2019 年 GSoD 大會結束後，我對未來的計畫非常明確。我也會繼續在其他專案中為機構貢獻心力。我會盡力從說明文件和安全性等各方面，盡力讓這項功能完美無缺。只要有機會，我一定會參加該組織的任何會議。
條款及細則
我鄭重同意，我會按照上述方式執行工作，如果發生任何錯誤，我會負起責任。我瞭解這個專案需要投入的專注，請放心，我會將整個賽季的時間投入這個專案，以便提供最佳作品。
感謝您閱讀整份提案。如有其他問題，歡迎與我們聯絡。