本頁詳細說明 Google 文件季度接受的一項技術撰寫專案詳細資料。
專案摘要
- 開放原始碼組織：
- GenPipes
- 技術撰稿人：
- shaloo
- 專案名稱：
- 前往「閱讀文件」設定 GenPipes 文件
- 專案長度：
- 標準長度 (3 個月)
Project description
為了達成設置 GenPipes 說明文件的目標，我想提供 3 步驟的計畫「閱讀文件」。
步驟 1：PoC
以新使用者 / 研究者的身分，查看 GenPipes 的現有文件
- 找出遺漏的資訊、不正確的資訊
- 建議新文件主題 (如有需要)
- 草稿資訊架構可用於解決目標對象，並將重點放在新使用者。
(注意：在這個步驟中，我們可能會需要 GenPipes 導師針對新的 GitHub 存放區設定輸入相關輸入內容，以便代管適用於 RTD 的基因管線文件。這個 GitHub 存放區可用來匯入 RTD 建構管道中的所有文件。如有需要，您可能需要深入瞭解 GenPipes 存放區規則和文件來源管理規範。否則可以使用標準值，也就是 afaik。此外，針對 PoC，我可以使用我的 GitHub 帳戶示範 RTD 存放區設定範例，例如 https://gpdocs.readthedocs.io/en/latest/ (這是我為此提案建立的取樣器)
根據上一步的審查和分析結果，針對 GenPipes 說明文件結構 / 索引建立基本架構，並放進 RTD 網站上
- 這涉及建立 GitHub 存放區 (例如使用 Sphinx 工具) 和基本說明文件檔案
- 此外，您也必須建立新的 TOC，以在各區段 / 資訊流中突顯新使用者和經驗豐富的用途。
查看 / 核准裸體骨骼 TOC
在 GenPipes GSoD 評估階段，我試著透過這個由 RTD 代管的範例為 GenPipes 創造價值。請注意，這項工具僅供示範之用，尚未在 RTD 中公開列出。無論是否列入候選名單，都能透過這個示範資源快速展開 GenPipes RTD。我已查看 c3g/GenPipes GitHub 存放區的來源。導師、Rola 和 Hector 都喜歡在 Skype「分享螢幕畫面」時喜歡這個內容，所以我想 GSoD Gods 也想看看。目前是骨骼的骨骼，但我計劃在時間允許的情況下更新，直到 7 月 30 日為止。
https://genpipes.readthedocs.io/en/latest/
步驟 2：GenPipes 文件 v0.9 文件集建立
找出目前或現有的 GenPipes 文件可匯入、連結或轉換為以 Sphinx/rst 為基礎的說明文件，以便在考量 RTD 格式時代管 GSoD 時程
將已識別的文件轉換為 rst 格式，並視需要建立新文件，並重複使用任何可能 / 相關的文件。
- 將這份初始文件匯入 ReadTheDocs 做為概念驗證，並代管為受保護的存放區。事先加上附註，建議新使用者在完成審查/正式切換作業之前，前往 GenPipes 原始說明文件。
複習/課程正確/更新
步驟 3：修正、檢查及發布 RTD 的第一個草稿
在 GenPipes TOC 中，填入 GenPipes 新文件架構建議的詳細資訊，除了前幾份文件 (GenPipes Readme)、概念、教學課程等，請新增其他文件。
在 TOC 中明確表達自我，對新使用者、經驗豐富的 GenPipes 使用者、GenPipes 開發人員等問題滿足他們的需求。
建議、透過 RTD (Sphinx 版本) 使用部分自動化功能討論工作流程，瞭解使用者如何維護、編輯 GenPipes 文件集，以及 C3G 是否允許外部文件協作者使用這項作業。這可能需要建立類似程式設計指南的文件更新指南。可能需要更多子步驟。例如，在 GenPipes 文件取得 PR 核准前，自動執行拼字檢查。
檢舉
最後，請依據經驗、記錄、導師意見回饋製作 GSoD 報告，
其他想法
日後 (3 個月以上)，我可以協助 GenPipes 的長期維護。或者，如有需要，也能訓練其他模型。我們可以根據前 3 個月的結果做出判斷。
此外，我也會建議額外的專案提案，建立 GenPipes 3 頁簡介，協助您輕鬆上手。現在，新使用者需要先跨越許多操作，才能開始使用 GenPipes，因為說明文件非常完善，且分散且不利於新使用者。我不確定是否能在 3 個月內執行這項操作，但我想試著做個檢查。
您也可以前往 https://drive.google.com/file/d/1oKVp_7ZeYGMxhynfc97qUUcGNh2CNbX0/view?usp=sharing 查看這項提案以及相關資訊 (記錄)