通用文档原则

为了获得最佳的用户体验和清晰度，请在创建 docs.ton.org 上的新内容时，牢记我们旨在应用于所有文档的一般性和重要要求列表。

为专业人士制作的文档

文档页面主要是为了文档目的而非作为教程，因此在文本中最小化使用个人示例或类比非常重要。确保内容既适合专业人士也适合非专业人士，同时仍然提供有价值的信息。

为了使读者更容易浏览文档，使用整个文档中一致的格式非常重要。使用标题、副标题、项目符号列表和编号列表来分隔文本，使其更易于阅读。

提供示例可以帮助读者更好地理解内容以及如何应用它。如果你正在编写文档页面并需要引用几个示例，请在“参考资料”和“参阅”部分之前创建一个特别的“示例”部分。请不要在文档页面中混合描述和示例。可以使用代码片段、截图或图表来阐述你的观点，使文档更具吸引力。

由于技术或软件更新可能导致技术文档迅速过时，因此定期审查和更新文档非常重要，以确保它保持准确和与当前软件版本相关。

在发布文档之前，最好从其他贡献者或用户那里获取反馈。这可以帮助识别可能令人困惑或不清楚的地方，并允许您在文档发布之前进行改进。