FreeBSD 專案

本頁將詳細說明 Google Season of Docs 接受的技術文件寫作專案。

專案摘要

開放原始碼組織：

FreeBSD 專案

技術文件撰稿者：

烤麵包機之王

專案名稱：

編寫缺少的手冊頁面，並在手冊頁面中加入範例章節

專案長度：

標準長度 (3 個月)

Project description

撰寫缺少的 man 頁面：

您可以在 https://wiki.freebsd.org/MissingManpages 查看缺少的 manpage 清單。從該清單中盡可能寫出盡可能多的頁面。在導師的協助下，請找出作者或最近變更來源檔案的使用者，對方是針對有問題的手冊頁面提供背景資訊和詳細資料。

在手冊頁面中加入 EXAMPLE 版面：

FreeBSD 說明文件頁面在許多地方都包含「EXAMPLE」(範例) 部分，說明其中所述公用程式或指令的基本用法。FreeBSD 維基百科提供了一覽表，列出沒有範例的手冊頁面 (https://wiki.freebsd.org/ManPagesWithoutExamples)。在適當情況下，請盡可能在這些 man 頁面中加入更多範例。請在這些章節中提供指令/公用程式的一般介紹方式 (例如先提供快速入門，再提供進階範例)，並將這些內容套用至說明類似公用程式/指令的手冊頁面。這樣一來，範例就會採用一致的做法，讀者也能更輕鬆地找到範例。