Dự án FreeBSD

Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.

Tóm tắt dự án

Tổ chức nguồn mở:

Dự án FreeBSD

Người viết nội dung kỹ thuật:

The King of Toasters

Tên dự án:

Viết các trang man bị thiếu, Thêm các phần MẪU vào trang man

Độ dài dự án:

Thời gian tiêu chuẩn (3 tháng)

Mô tả dự án

Viết những trang người đàn ông bị thiếu:

Có một danh sách các trang man bị thiếu trên https://wiki.freebsd.org/MissingManpages. Bắt đầu viết càng nhiều trang người dùng càng tốt trong danh sách đó. Với sự trợ giúp của người cố vấn, hãy tìm tác giả hoặc người gần đây đã thay đổi tệp nguồn mà trang man có liên quan để biết thông tin cơ bản và thông tin chi tiết.

Thêm phần VÍ DỤ vào trang nam:

Các trang dành cho người của FreeBSD bao gồm nhiều vị trí, trong đó có các phần VÍ DỤ, mô tả cách sử dụng cơ bản của tiện ích hoặc lệnh được mô tả trong đó. Trang wiki của FreeBSD có danh sách các trang man không có ví dụ (https://wiki.freebsd.org/ManPagesWithoutExamples). Thêm càng nhiều ví dụ vào các trang man này càng tốt trong trường hợp cần thiết. Đưa ra cách chung để giới thiệu lệnh/tiện ích trong các phần này (tức là bắt đầu nhanh trước, sau đó là các ví dụ nâng cao hơn) và áp dụng cách đó cho các trang man mô tả các tiện ích/lệnh tương tự. Bằng cách đó, các ví dụ sẽ có một phương pháp nhất quán và người đọc có thể tìm thấy nội dung dễ dàng hơn.