记录新功能和变更¶
每一次 Blender 版本的发布,都会引入令人兴奋的新功能、改进和变化。为了确保 Blender 用户能充分利用这些更新,文档也需要同步更新。
Blender 文档项目跟踪需要对手册进行更新或添加的变更。您的贡献将有助于保持手册的准确性和对全球 Blender 社区的价值。
本指南将指导您使用发布问题和提交日志来记录这些变更。
Using Release Issues to Track Changes¶
Each Blender release has an associated issue in the documentation project's Upcoming Releases Project. These issues contains a curated list of code commits from Blender's development process that introduce user-facing changes. These changes typically require updates to the manual, such as new sections, modified instructions, or updated screenshots.
Steps to Contribute
Locate the Release Issue:
Navigate to the documentation project's issue tracker and open the issue for the current or upcoming Blender release.
Review the list of commits provided in the issue description. Each commit represents a change or feature that needs documentation.
Pick a Commit:
Select a commit that interests you or aligns with your expertise. For example, if you're familiar with modeling tools, pick a change related to those features.
Make sure no one else is already working on the same task by checking the comments or status updates in the issue.
Understand the Change:
Read the Commit Message:
Commit messages often summarize the purpose and scope of the change. They might link to a pull request (PR) or contain related discussion links.
Check the PR or Code:
The linked PR provides additional context, including descriptions, images, or videos explaining the feature. Reviewing the code changes can also help you understand how the feature works.
测试功能:
Open Blender and test the feature to see it in action. This hands-on experience will clarify how the feature behaves and how users will interact with it.
Reach Out if Needed:
If the commit message or PR doesn't provide enough information, you can:
Contact the developer of the change (their username is typically in the PR).
Ask questions on Blender's development channels or forums.
文档编写的关键注意事项¶
在记录变更时,请注意以下几点:
目的是什么?:
了解进行更改的原因。是为了提高可用性、引入新功能,还是为了解决问题?
谁将受益?:
考虑功能的目标受众。是针对动画师、建模师还是其他用户群体?
如何工作的?:
编写简洁明了的说明。尽可能包含实际示例或使用案例。
查找依赖关系:
某些更改可能取决于其他功能或影响现有功能。请检查更改是否会影响手册的其他部分。
屏幕截图和视觉资料:
如果更改会影响 Blender 的界面,请截图说明。确保视觉资料能反映出 Blender 的正确版本。
Submitting Your Work¶
一旦你起草了文件:
以手册样式书写:
遵循 Blender 文档样式指南,以确保清晰度和一致性。
提交您的贡献:
在文档项目中打开一个拉取请求。
Reference the release issue and the commit in your PR description.
包含您创建的任何截图、图表或示例。
合作:
与审核团队合作,完善您的文档,直至可以发布。
每一份贡献都至关重要¶
为 Blender 文档做出贡献是支持社区并确保用户了解最新功能的一种有益方式。通过记录这些更改,您将在让 Blender 更易于使用、让每个人都能享受其中的乐趣方面发挥关键作用。
今天就开始探索版本问题,帮助实现 Blender 的创新!