参考页应遵循标准布局。这使得用户能够更快地找到所需信息，同时也鼓励作者记录命令的所有相关方面。一致性不仅体现在 PostgreSQL 参考页之间，还应与操作系统和其他软件包提供的参考页保持一致。因此，我们制定了以下指南。这些指南在很大程度上与各操作系统制定的类似指南一致。
描述可执行命令的参考页应按以下顺序包含以下部分。不适用的部分可以省略。除非有特殊情况，否则不应使用额外的顶级部分；通常这些信息属于“Usage”（用法）部分。
此部分自动生成。它包含命令名称及其功能的半句话摘要。
此部分包含命令的语法图。概要通常不应列出每个命令行选项；该信息在下面列出。相反，应列出命令行主要组件，例如输入和输出文件的位置。
几段解释该命令的功能。
列出并描述每个命令行选项。如果选项很多，可以使用子部分。
如果程序使用 0 表示成功，非零表示失败，则无需记录。如果不同的非零退出码有特定含义，请在此列出。
描述程序的任何子语言或运行时接口。如果程序不是交互式的，通常可以省略此部分。否则，此部分是描述运行时功能的“集装箱”。如有必要，请使用子部分。
列出程序可能使用的所有环境变量。尽量详尽；即使是像 SHELL 这样看似微不足道的变量也可能引起用户的兴趣。
列出程序可能隐式访问的任何文件。也就是说，不要列出在命令行中指定的输入和输出文件，而是列出配置文件等。
解释程序可能产生的任何不寻常的输出。避免列出每个可能的错误消息。这工作量很大，实际用处不大。但是，如果错误消息具有用户可以解析的标准格式，则应在此解释。
任何不适合放在其他地方的内容，特别是 bug、实现缺陷、安全注意事项、兼容性问题。
示例
如果程序在历史上有一些重要的里程碑，可以列在这里。通常可以省略此部分。
作者（仅用于 contrib 部分）
交叉引用，按以下顺序排列：其他 PostgreSQL 命令参考页、PostgreSQL SQL 命令参考页、PostgreSQL 手册引用、其他参考页（例如，操作系统、其他软件包）、其他文档。同一组中的项目按字母顺序排列。
描述 SQL 命令的参考页应包含以下部分：Name（名称）、Synopsis（概要）、Description（描述）、Parameters（参数）、Outputs（输出）、Notes（注释）、Examples（示例）、Compatibility（兼容性）、History（历史）、See Also（参见）。Parameters（参数）部分类似于 Options（选项）部分，但对命令的哪些子句可以列出有更多自由。只有当命令返回的内容不是默认的命令完成标签时，才需要 Outputs（输出）部分。Compatibility（兼容性）部分应解释该命令在多大程度上符合 SQL 标准，或与哪个其他数据库系统兼容。SQL 命令的 See Also（参见）部分应先列出 SQL 命令，然后列出对程序的交叉引用。
如果您在文档中发现任何不正确、与您在该特定功能上的经验不符或需要进一步澄清的内容，请使用 此表单 报告文档问题。