返回列表 发帖

Vue 3.0文档编写指南#迭代 & 沟通

卓越源于迭代初稿总是很糟糕,但是编写初稿是该过程的重要组成部分。要避免进度缓慢,很难-不好-> OK->好->好->鼓舞人心->超越。
在发布之前,请仅等到某事为“好”为止。社区将帮助你将其推向更深的链。
收到反馈时,尽量不要防御我们的写作对我们来说可能是非常私人的,但是如果我们对帮助我们做得更好的人感到不满,他们要么停止提供反馈,要么开始限制他们提供的反馈种类。
在向他人展示之前,请先阅读自己的作品。如果你显示某人的拼写/语法错误很多,你将获得有关拼写语法/错误的反馈,而不是获得有关写作是否达到目标的更有价值的注释。
当你要求人们提供反馈时,请告诉审阅者以下内容:
你正在尝试做
你的恐惧是
你想要达到的平衡
当有人报告问题时,几乎总是有问题,即使他们提出的解决方案不太正确。不断询问后续问题以了解更多信息
人们在提交/查看内容时需要放心地提问。这是你可以执行的操作:
即使别人感到脾气暴躁,也要感谢他们的贡献/评价
。比如:

“Great question!”
“感谢你抽出宝贵的时间来解释。????”
“这实际上是故意的,但感谢你抽出宝贵的时间来贡献自己的力量。 ????”
听别人说什么,如果不确定自己是否正确理解,请照搬。这可以帮助验证人们的感受和经历,同时还可以了解你是否正确理解了他们。
使用大量积极和善解人意的表情符号。显得有些奇怪总比刻薄或急躁好。
请传达规则/边界。如果某人的举止有辱人格/不当行为,请仅以仁慈和成熟来回应,但也要明确表示,这种行为是不可接受的,如果他们继续表现不佳,将会发生什么 (根据行为准则)。
#提示、标注、警告和行高亮
我们有一些专用的样式来表示需要以特定方式突出显示的内容。这些被捕获为在这个页面请谨慎使用。

滥用这些样式是有一定诱惑力的,因为你可以简单地在标注中添加更改。但是,这会破坏用户的阅读流程,因此,只能在特殊情况下使用。在可能的情况下,我们应该尝试在页面内创建一个叙述和流程,以尊重读者的认知负荷。

在任何情况下都不应该相邻使用两个警告,这表明我们无法很好地解释上下文。

#贡献
我们欣赏小型、集中的 PR。如果你想进行非常大的更改,请在发起请求之前与团队成员沟通。这是一份详细说明为什么这一点如此重要的书面材料让我们在这个团队里工作得很好。请理解,尽管我们总是很感激你的贡献,但最终我们必须优先考虑哪些对整个项目最有效。

返回列表