本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- 關於 Code
- 技術文件撰寫者：
- ayansinha
- 專案名稱：
- Scancode- Toolkit 的指令列選項參考資料，以及「ResstructCode」說明文件的結構 (網址為 aboutcode.readthedocs.io)
- 專案長度：
- 標準長度 (3 個月)
Project description
[ 1. Scancode-Toolkit 指令行選項 ]
Scancode-Toolkit 提供多個指令列選項，可用來自訂掃描執行方式、輸出格式和其他多個選項，例如掃描後外掛程式。這些選項目前未提供適當的說明文件，只能透過「--help」或「-h」標記取得。這項專案旨在提供完整說明文件，以瞭解下列資訊：
[ 1. 所有可用選項 ，盡在指令列 ]
- 目標：透過指令列取得所有可用選項的完整清單。
- 基本總覽：首先，我們會說明預設掃描選項，並提供輸出範例。掃描執行方式的簡短圖片/說明。
之後，此預設行為可做為其他選項變更掃描和輸出內容的方式。
我們將詳細說明這些內容，其中包含下節提及的下列資訊。
[ 2. 啟動版本管理結構 ]
- 目標：啟動版本管理系統，以妥善維持跨發布選項/API 和說明文件的變更。
- 問題：在維基和 ReadTheDocs 網頁中呈現文件屬於舊版，需要大幅重組。
- 基本總覽： Scancode-kit 經過更新/可於版本中更新的部分為
- 指令列選項
- API
- 說明文件 (準備啟動) 在版本和發布版本中，指令列選項和 API 有所變動，說明文件也必須遵循，否則使用者會造成嚴重的混淆。任何選項變更都已更新指令列公用程式 [ --help ]，可用來複製說明文件中的版本管理。
[ 3. 這些選項在不同情況下可以如何運用 ]
- 目標：本節將提供基本摘要，說明 Scancode- Toolkit 的掃描結果在不同情況下的使用方式，以及提供這類功能的 Scancode-Toolkit 選項。
- 基本總覽：本節提供不同的使用情境範例，以及這些情境建議可採用的選項。
- 注意：這個部分需要導師針對 Scancode-Toolkit 各種用途的輸入內容提供重大協助。
[ 4. 這些選項在掃描和輸出中有什麼變化 ]
- 目標：本節將概略說明掃描程式碼工具包的掃描結果在不同情況下的用途，以及提供這類功能的「關於」工具。
- 基本總覽：選項會變更掃描執行行為。 前面部分 [ 1. 可透過指令列 取得的所有選項 和 本部分比較所有選項對這個預設情境帶來的變更。
[ 5. 輸出格式及其範例 ]
- 目標：本節將概略說明掃描程式碼工具包的掃描結果在不同情況下的用途，以及提供這類功能的「關於」工具。
- 基本總覽：Scancode-Tool 含有用於指定不同輸出格式 (用於產生掃描結果) 的旗標。這些是 -
這個部分 - 並詳細說明輸出格式
- 這裡有一些輸出格式範例
- 提供與輸出格式相對應的連結，以及該格式的用途
- 如何在輸出檔案中儲存掃描結果。 這個頁面也會提供這些不同格式的產生方式連結，詳細說明請見：[ 2. 討論程式碼掃描方法的討論內容。
[ 6. 掃描代碼輸出格式的業務用途 ]
- 目標：說明掃描程式碼輸出格式的業務用途 在 GSoD 構想清單中，掃描程式碼輸出格式是參考概念。本節內容也相同。
- 注意：這部分需要導師對 Scancode-Toolkit 各種業務用途的輸入與指標提供重大協助。
[ 7. 如何讓其他 AboutCode 專案運用這些輸出內容進行進一步分析 ]
- 目標：本節將概略說明掃描程式碼工具包的掃描結果在不同情況下的用途，以及提供這類功能的「關於」工具。
- 基本總覽：
- Scancode-Workbench 這部分說明如何使用電腦版應用程式以視覺化方式呈現結果，以及掃描程式碼工作平台說明文件的指標，以取得更多相同支援。如有需要，將新增必要文件至 Scancode-workbench。
- 差異碼
[ 2. 重新整理 AboutCode 說明文件的結構 ]
本節包括對關於程式碼說明文件所做的多項變更
[ 1. 版本管理系統 ]
[1. Scancode-Toolkit 指令行選項 -> 2。啟動版本管理結構] 提及指令列選項版本管理的問題。此外，說明文件的其他部分也必須包含版本專屬指令/資訊，以免造成混淆。
[ 2. 設定說明文件標準和測試 ]
說明文件已測試 spinx-build (建立所有網頁並檢查整個 Sphinx 語法錯誤) 和連結檢查 (檢查文件中所有連向其他網頁的連結) 以及透過 Travis-CI 的持續整合。(由我在這個提取要求 #17 中新增) 現在需要針對重結構化文字和其他標準中的特定程式碼檢查執行更多檢查。重塑文字 Lint 可以做到這一點，但需要更多研究才能完成，而且會在 GSoD 專案中進行。
[ 3. 加入「開始使用」章節 ]
這是新手入門章節，當中含有最基礎和重要文件的編譯內容，可開始使用「Aboutcode Projects」。所有 Aboutcode 專案都會有這個區段，包括 Scancode-Toolkit、Scancode-Workbench、Deltacode 等。
[ 4. 根據 4 個文件函式重新建構 ]
現有說明文件並未在 4 種文件函式中明確架構：教學課程、操作說明、參考資料和說明。我會據此建構這些架構，並在必要時加入更多資訊/說明或指標。這個訴訟保留適用於所有 AboutCode 專案及其說明文件。以下提供兩個範例，說明我提議調整和接下來希望採用的 Scancode-Toolkit 說明文件結構。類似的變更將在文件的其餘部分進行。
[ 5. 重組開發頁面 (Scancode-Toolkit) ]
您可以新增程式碼/API 的詳細資訊，讓開發人員更容易使用。 您隨時可以提供 [ 2. 說明上方「程式碼掃描」一節的討論。這個連結會說明掃描作業如何與其用於執行掃描的程式碼。如同這些資料夾包含掃描碼工具包的不同部分，這些資料夾的個別用途可以與 API 一起詳細描述，然後在有關 Scancode 運作方式的「討論」中一併說明。
- [ cluecode ：用於掃描授權、版權、網址、電子郵件的外掛程式 ]
- [通用程式碼：輔助類別和函式]
- [ 擷取程式碼： 擷取不同的封存格式 ]
- [格式化程式碼：不同輸出檔案格式的輸出格式 ]
- [Licensecode : licence 偵測 code ]
- [ 封裝程式碼：剖析各種套件格式 ]
- [ plugincode : class for the plugins Framework ]
- [Summarycode : 總結偵測到的授權掃描結果 ]
- [ textcode ：處理文字剖析 ]
- [ typecode ：處理檔案類型判定 ]
- [Scancode：透過 CLI 和 API 掃描程式碼，核心部分 ]
本節將視情況在子小節中，針對掃描程式碼工具包的這些部分提供詳細資訊/API。 「開發指南」會顯示在另一個頁面或另一個部分含有較小的子區段。
[ 6. 重組常見問題網頁 (Scancode-Toolkit) ]
目前的常見問題網頁包含不恰當的問題，應分別以「使用方法」、「教學課程」和「參考資料」等獨立結構描述。
- ScanCode 的運作方式為何？這個問題在 [ 2. 討論 程式碼掃描 ]，並專門探討這個章節，深入探討更多詳細資訊。
- 如何新增 Enhanced 偵測功能的授權規則？ 這個問題已在「改善現有的教學方法」之前討論過，因此說明文件會移至該工具。
- 如何新增授權偵測規則？ 換句話說，您可以另外張貼一則「操作說明」貼文，進一步加以強調。
- 如何開始開發？ 目前已經有獨立的開發頁面，而且資訊重疊性許多。開發頁面重構作業已在上方討論過。
- 剪下新版本的步驟 您可將其轉換為個別的「如何剪輯新版本」。
- 尋找更多常見問題解答，如果問題不屬於「教學示範」類別，哪些則不屬於「教學示範」類別。