โปรเจ็กต์ FreeBSD

หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs

สรุปโปรเจ็กต์

องค์กรโอเพนซอร์ส

The FreeBSD Project

นักเขียนเชิงเทคนิค:

The King of Toasters

ชื่อโปรเจ็กต์:

เขียนหน้าแมนที่ขาดหายไป เพิ่มส่วนตัวอย่างลงในหน้าแมน

ระยะเวลาของโปรเจ็กต์

ระยะเวลามาตรฐาน (3 เดือน)

คำอธิบายโปรเจ็กต์

เขียนหน้าบุคคลที่ขาดหายไป:

ดูรายการหน้าแมนที่ขาดหายไปได้ที่ https://wiki.freebsd.org/MissingManpages เริ่มเขียนคู่มือจากรายการดังกล่าวให้ได้มากที่สุด โปรดขอความช่วยเหลือจากพี่เลี้ยงเพื่อค้นหาผู้เขียนหรือผู้ที่เพิ่งเปลี่ยนไฟล์ต้นฉบับที่เกี่ยวข้องกับหน้า man ดังกล่าวเพื่อขอข้อมูลเบื้องต้นและรายละเอียด

เพิ่มส่วน "EXAMPLE" ลงในหน้าบุคคล:

หน้า man ของ FreeBSD มีหัวข้อตัวอย่างอยู่หลายที่ ซึ่งอธิบายการใช้งานพื้นฐานของยูทิลิตีหรือคำสั่งที่อธิบายไว้ วิกิของ FreeBSD มีรายการหน้าแมนที่ไม่มีตัวอย่าง (https://wiki.freebsd.org/ManPagesWithoutExamples) เพิ่มตัวอย่างลงในหน้าแมนเหล่านี้ให้มากที่สุดเท่าที่จะทำได้หากมีตัวอย่างพอสมควร หาวิธีทั่วไปในการแนะนำคำสั่ง/ยูทิลิตีในส่วนเหล่านี้ (เช่น เริ่มต้นใช้งานฉบับย่อก่อน แล้วตามด้วยตัวอย่างขั้นสูง) และใช้วิธีนั้นกับหน้าแมนอธิบายยูทิลิตี/คำสั่งที่คล้ายกัน วิธีนี้จะช่วยให้ตัวอย่างมีแนวทางที่สอดคล้องกันและช่วยให้ผู้อ่านค้นหาสิ่งต่างๆ ได้ง่ายขึ้น