FreeBSD 项目
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- FreeBSD 项目
- 技术文档工程师：
- The King of Toasters
- 项目名称：
- 编写缺失的手册页面，在手册页面中添加 EXAMPLE 部分
- 项目时长：
- 标准时长（3 个月）
Project description
编写缺少的 man 页面：
您可以在 https://wiki.freebsd.org/MissingManpages 上查看缺少的手册页列表。开始撰写该列表中的尽可能多的手册。在导师的帮助下，找到相关手册页所涉及的源文件的作者或最近更改过该源文件的人员，以获取背景信息和详细信息。
在手册页面中添加 EXAMPLE 部分：
FreeBSD 手册页的许多地方都包含“示例”部分，其中介绍了其中所述实用程序或命令的基本用法。FreeBSD Wiki 上提供了一个不带示例的手册页列表 (https://wiki.freebsd.org/ManPagesWithoutExamples)。在适当的情况下，请尽可能向这些手册页添加尽可能多的示例。在这些部分中，设计一种介绍命令/实用程序的通用方法（即先介绍快速入门，然后再介绍更高级的示例），并将其应用于介绍类似实用程序/命令的手册页。这样，示例便具有一致的方法，并且读者可以更轻松地找到所需内容。
如未另行说明，那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可。有关详情，请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC)：2025-07-25。
[[["易于理解","easyToUnderstand","thumb-up"],["解决了我的问题","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["没有我需要的信息","missingTheInformationINeed","thumb-down"],["太复杂/步骤太多","tooComplicatedTooManySteps","thumb-down"],["内容需要更新","outOfDate","thumb-down"],["翻译问题","translationIssue","thumb-down"],["示例/代码问题","samplesCodeIssue","thumb-down"],["其他","otherDown","thumb-down"]],["最后更新时间 (UTC)：2025-07-25。"],[],["The FreeBSD Project, in collaboration with technical writer \"The King of Toasters,\" will undertake a technical writing project focused on man pages. The project includes creating missing man pages from a specified list, using source file authors for guidance. Additionally, the project will add EXAMPLE sections to existing man pages that lack them, following a consistent structure of introductory and then advanced examples to improve readability and usability. The project duration will be three months.\n"]]
