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