本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- Django
- 技術文件撰寫者：
- Gabbyprecious
- 專案名稱：
- 改寫貢獻指南，讓使用者更容易瀏覽及瀏覽
- 專案長度：
- 標準長度 (3 個月)
Project description
黑白
在這個案例中，Django 做出貢獻指南的目標，在於引導使用者，開放原始碼貢獻者瞭解其貢獻方式與協助，讓 Django 得以更臻完善且永續。
使用者始終需要製作對社群和 Django 本身有重大影響的文件。
今年的 Google 文件夏日活動，Django 的目標是讓貢獻指南不再為大家帶來許多困難、更容易取得，也更歡迎協作者。這項目標能夠鼓勵貢獻者參與這個優秀的架構，而我也是不可或缺的目標。
目前狀態
目前說明文件的發展階段，實在太過太多，且結構不夠完善，因此較無法理解 Django 中的貢獻，也較不歡迎新貢獻者參與。
專案目標
我和導師 Carlton Gibson 在論壇中討論我對說明文件的建議，並且核准他能解決目前文件的大量問題。我預計重組文件： 重組文件 新增章節注意事項 新增章節規則
目前的說明文件已鎖定進階貢獻者，且無法為開放原始碼和 Django 等新手和新手貢獻者提供額外內容：進入目前的說明文件幾個部分，重新撰寫並新增至新手章節。 說明進階章節所使用重點或字詞的章節。
時間表
以下詳細說明我希望透過 Google 提供的日曆完成上述專案目標。
社群凝聚週( 8 月 17 日 - 9 月 13 日) 內部貢獻更多心力 繼續在說明文件中貢獻更多內容 貢獻者分享更多建議 深入介紹現有文件和預定工具 第 1 週至第 4 週 參考「等級」文件的撰寫說明文件 新增「貢獻者第 4 週」及「貢獻者」章節 「編輯作品主題」部分
工具
Sphinx：目前說明文件適用的目前工具。閱讀說明文件。
專案原因
我負責撰寫詳盡的書面文件和文章，讓世上的所有人受惠。除此之外，我也是 Django 和開放原始碼團隊整體的愛用者。我的意義在於協助 Django 成為新手，我認為這是為我喜愛的工具貢獻心力的絕佳方式，同時也能熟悉程式碼集，讓開發人員(以及技術撰寫者) 能獲得更多貢獻。和我的觀點都看似不落人後，能和我合作。這對我的職涯來說是絕佳的工具，真的很開心。
為什麼我是這項專案的負責人？
我相信我是擁有下列帳戶的使用者的合適人選：我曾撰寫文章，協助新手瞭解 Django 的概念。 身為開發人員，目前也希望能為 Django 做出貢獻，我瞭解需要其他開發人員，以及如何為他們妥善記錄。 我是隊員，在輔導老師 Carlton Gibson 的情況下學習成效十分良好。