记录新功能和变更¶
每一次 Blender 版本的发布,都会引入令人兴奋的新功能、改进和变化。为了确保 Blender 用户能充分利用这些更新,文档也需要同步更新。
Blender 文档项目跟踪需要对手册进行更新或添加的变更。您的贡献将有助于保持手册的准确性和对全球 Blender 社区的价值。
本指南将指导您使用发布问题和提交日志来记录这些变更。
使用发布问题来跟踪变更¶
每个 Blender 版本在文档项目的即将发布的版本项目中都有一个对应的任务。这些任务包含一份经过筛选的代码提交列表,这些提交来自 Blender 的开发过程,并引入了面向用户的变更。这些变更通常需要对手册进行更新,例如新增章节、修改说明或更新截图。
贡献的步骤
查找发布问题:
访问文档项目的问题跟踪器,并打开当前或即将发布的 Blender 版本的相关问题。
请查看问题描述中提供的提交列表。每个提交都代表一项需要编写文档的更改或功能。
选择一个提交:
选择一个您感兴趣或符合您专业领域的提交。例如,如果您熟悉建模工具,请选择一个与这些功能相关的更改。
请查看该问题中的评论或状态更新,确保没有其他人已经在处理同一项任务。
理解变更:
阅读提交信息:
提交信息通常会概括更改的目的和范围。它们可能会链接到一个拉取请求(PR),或包含相关讨论的链接。
查看 PR 或代码*:
链接中的 PR 提供了更多背景信息,包括对该功能的说明、图片或视频。查看代码变更也能帮助你理解该功能的工作原理。
测试功能:
打开 Blender 并测试该功能,亲身体验其实际运行效果。通过这种实践操作,您将清楚地了解该功能的工作原理以及用户如何与之交互。
如有需要请联系*:
如果提交信息或拉取请求中提供的信息不够充分,您可以:
请联系该更改的开发者(其用户名通常会在 PR 中显示)。
请在 Blender 的开发频道或论坛上提问。
文档编写的关键注意事项¶
在记录变更时,请注意以下几点:
目的是什么?:
了解进行更改的原因。是为了提高可用性、引入新功能,还是为了解决问题?
谁将受益?:
考虑功能的目标受众。是针对动画师、建模师还是其他用户群体?
如何工作的?:
编写简洁明了的说明。尽可能包含实际示例或使用案例。
查找依赖关系:
某些更改可能取决于其他功能或影响现有功能。请检查更改是否会影响手册的其他部分。
屏幕截图和视觉资料:
如果更改会影响 Blender 的界面,请截图说明。确保视觉资料能反映出 Blender 的正确版本。
Submitting Your Work¶
一旦您起草了文件:
以手册样式书写:
遵循 Blender 文档样式指南,以确保清晰度和一致性。
提交您的贡献:
在文档项目中打开一个拉取请求。
请在你的 PR 描述中提及该发布版本和相关提交。
包含您创建的任何截图、图表或示例。
合作:
与审核团队合作,完善您的文档,直至可以发布。
每一份贡献都至关重要¶
为 Blender 文档做出贡献是支持社区并确保用户了解最新功能的一种有益方式。通过记录这些更改,您将在让 Blender 更易于使用、让每个人都能享受其中的乐趣方面发挥关键作用。
今天就开始探索版本问题,帮助实现 Blender 的创新!