4、技术文档编写指南

技术文档编写指南

1. 代码示例

代码示例是计算机程序的一部分，用于在文档中辅助解释主题。它可以包含用户输入与计算机响应之间的对话，也可以仅包含用户输入到计算机的代码。

由于编程代码具有精确性，必须原样复制代码，即使代码存在拼写、语法或标点方面的语言错误。若有机会，应将错误告知提供代码的个人或团队，以便在源文件中进行修正。

如果要在文档开头的代码示例列表中包含代码示例，需添加标题。标题的大小写和标点应遵循常规标题的格式。

注意：如果要展示冗长的程序，应将其放在附录中并进行交叉引用，除非整个文档主要由长代码示例组成。

以下是一个代码示例：

struct inode { struct inode *i_chain[2]; struct vnode i_vnode; struct vnode *i_devvp; u_short i_flag; };

2. 错误消息

在记录错误消息时，需遵循以下准则：
- 原样复制消息文本。
- 错误消息文本使用等宽字体。
- 错误消息的格式应与段落文本有所区别。
- 错误消息之后应始终跟随对消息显示原因的描述以及读者可采取的纠正措施。

如果要记录大量错误消息，可以考虑将它们汇编到附录中，甚至单独成书。

以下是错误消息的文本和表格格式示例：
-文本格式示例：

<