本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- Django
- 技術撰稿人：
- Gabbyprecious
- 專案名稱：
- 改寫貢獻指南，讓使用者更容易瀏覽
- 專案長度：
- 標準長度 (3 個月)
Project description
ABSTRACT
如同所有其他說明文件，Django 的貢獻指南的目標在於引導使用者、開放原始碼貢獻者在這個案例中引導他們如何做出貢獻，以及幫助 Django 變得更好、更永續。
我們始終需要編寫說明文件，尤其是對社群和 Django 本身影響重大的說明文件。
Django 在本年度 Google 文件夏季活動的目標，是讓貢獻指南更容易上手，讓貢獻者更容易存取，並歡迎貢獻者參與。這是一項重要的目標，因為我們鼓勵貢獻者在這個優秀架構中貢獻一己之力。
目前情況
這裡提供說明文件目前的階段，並不能只侷限於指引，因為資訊內容過多且結構不夠完整，會導致使用者較不瞭解 Django 中的貢獻，而非歡迎新貢獻者。
專案目標
我已在論壇中與導師 Carlton Gibson 討論了說明文件的建議，他同意這項建議可解決目前說明文件中的問題。以下是我計畫達成的目標，以便重整文件： 重整文件 新增各部分的「Dos」和「Don’ts」 針對「Requesting」和「making」等瑣碎部分建立單頁文件 縮減並直接切入重點的說明文件 提供字詞的字彙表 內部索引，以便遵循新指南 撰寫更貼近使用者需求的說明文件 將內容區分為兩個主要部分 (初學者和進階貢獻者部分) 為新技術撰寫人/貢獻者建立指南和風格，以便讓說明文件保持最新狀態並遵循標準。
目前的文件已鎖定進階貢獻者，因此新手和初學者無法透過開放原始碼和 Django 解決問題。以下是一些初學者適用的額外內容： 指引不同貢獻者(技術作家、設計師和開發人員) 的專區 記錄初學者問題和可解決的簡單問題的頁面。將目前文件中的幾個部分重寫並新增至初學者專區。解釋進階章節中使用的重點或字詞。
時間軸
以下將說明我如何使用 Google 提供的日曆，執行上述專案目標。
Community bonding week( August 17 - September 13) Get to engage more with the community Continue contributing to the documentation Getting more suggestions from Contributors More study of current Documentation and intended tools Week 1 - week 4 Start out on sectioning documentation based on Levels Create the beginners section of documentation Week 4 - 6 Curating Dos and Don’ts Writing out sectional Dos and Don’ts Additional pages for sections Week 7 - 9 Rewrite and move current documentation to Advanced Contributor guide Reduced Documentation Week 10 - 12 Prepare Glossary Update Internal Index to new documentation Create a guide and style for incoming technical writers/contributors
工具
Sphinx - 目前說明文件適用的工具。 閱讀說明文件。
為何選擇這項專案？
我深信，只要撰寫得宜的文檔和文章，就能涵蓋世界各地的使用者。除此之外，我也是 Django 和開放原始碼的愛好者。我一直想以初學者的身分為 Django 做出貢獻，我認為這是為我最愛的工具做出貢獻的絕佳方式，同時也能熟悉程式碼庫，以開發人員(和技術撰稿人) 身分提供更多貢獻。與與我觀點一致的機構合作，並使用這項工具協助我整個職涯，是一件令人愉快且美好的事。
為什麼我適合負責這個專案？
我相信自己是下列帳戶的合適人員： 我撰寫文章來協助初學者深入瞭解 Django 的概念，因此協助 Django 貢獻一己之力。 身為開發人員，我期待為 Django 做出貢獻，因此瞭解開發人員的需求，也知道如何為他們提供良好的文件。我是一個團隊合作者，在導師 Carlton Gibson 的監督下，我能妥善完成工作，不論監督程度為何。