这份指南旨在帮助开发者、贡献者和文档编写者了解 TensorFlow 文档的风格和最佳实践。
语言风格
- 中文:如果您正在阅读此文档的中文版本,您将获得关于 TensorFlow 文档中文风格的指导。
- 英文:If you are reading this in English, you will find guidance on the English style for TensorFlow documentation.
内容结构
- 标题:每个文档应有一个清晰、简洁的标题。
- 子标题:使用子标题来组织内容,使读者易于浏览。
- 代码示例:使用代码块展示代码示例,并确保代码可复制。
文档写作
- 清晰性:确保文档内容清晰易懂,避免使用过于复杂的术语。
- 准确性:确保文档中的信息准确无误。
- 一致性:保持文档风格和术语的一致性。
代码风格
- 格式化:遵循 PEP 8 或其他适用的代码风格指南。
- 注释:为代码添加必要的注释,解释代码的功能。
图片和图表
- 图片:使用高质量的图片和图表来增强文档的可读性。
- 链接:为图片添加描述性文本,并确保链接正确。
TensorFlow Logo
相关链接
希望这份指南能帮助您更好地编写 TensorFlow 文档。