Added translation of base-documentation by WillemJiang · Pull Request #25 · WillemJiang/InnerSourcePatterns

WillemJiang · 2022-12-28T13:38:26Z

sunzhh02 · 2022-12-31T04:19:07Z

+
+## 上下文
+
+一个项目要作为一个内源项目与他人分享。为了让其他人能够理解项目的内容以及如何做出贡献，项目需要提供一些基本的文件。到目前为止，该项目要么缺乏所有的文档，要么缺乏用户以自我服务的方式进行尝试以及贡献者快速上手所需的某些方面的内容。


可以考虑”base level documentation“翻译为”“基准级的文档”。此处的“自我服务”，建议翻译为“自助”。

已采纳。

sunzhh02 · 2022-12-31T04:48:25Z

+
+## 约束
+
+- 该项目最近才转为内源项目。以前，用户要么是内部的，要么是在个人面对面的会议上加入进来的。同样，在项目中工作的人员也是通过个人入职指导加入到项目中，而这种入职指导并不能随着贡献者或远程贡献者人数的增加而扩大。因此，自我服务文件是缺乏的。


建议：“在项目中工作的人员也是通过个人入职指导加入到项目中”翻译为“从事项目的人员经历了入职培训” ； “入职指导”翻译为“入职培训”，“自我服务文件”翻译为“自助服务文档”。

已采纳。

sunzhh02 · 2022-12-31T04:55:30Z

+## 约束
+
+- 该项目最近才转为内源项目。以前，用户要么是内部的，要么是在个人面对面的会议上加入进来的。同样，在项目中工作的人员也是通过个人入职指导加入到项目中，而这种入职指导并不能随着贡献者或远程贡献者人数的增加而扩大。因此，自我服务文件是缺乏的。
+- 该项目是作为一个内源项目新创建的。然而，东道主团队缺乏内源的经验。因此，他们需要指导在文档中包括哪些信息，把文档放在哪里，以便其他人可以找到它，以及在文档中面向的是哪些类型的读者。


host team需要统一一下翻译，比如“东道主团队”还是“主办团队”更好。

这里“”指导“可以翻译成”被指导“，或者”指导建议，关于“。

已采纳。host team 采用东道主团队译法。

sunzhh02 · 2022-12-31T04:57:39Z

+
+- 该项目最近才转为内源项目。以前，用户要么是内部的，要么是在个人面对面的会议上加入进来的。同样，在项目中工作的人员也是通过个人入职指导加入到项目中，而这种入职指导并不能随着贡献者或远程贡献者人数的增加而扩大。因此，自我服务文件是缺乏的。
+- 该项目是作为一个内源项目新创建的。然而，东道主团队缺乏内源的经验。因此，他们需要指导在文档中包括哪些信息，把文档放在哪里，以便其他人可以找到它，以及在文档中面向的是哪些类型的读者。
+- 该项目是最近才转为内源项目的，主办团队对内源的经验有限。因此，现有的文档解决了很多技术方面的问题。它不包括沟通、协调、促进透明规划所需的信息。


host team需要统一一下翻译，比如“东道主团队”还是“主办团队”更好。

”它不包括沟通、协调、促进透明规划所需的信息。“翻译为”不包括促进透明规划所需的沟通、协调和信息。“ 看起来更合适。

已采纳。

sunzhh02 · 2022-12-31T05:11:59Z

+- 该项目是作为一个内源项目新创建的。然而，东道主团队缺乏内源的经验。因此，他们需要指导在文档中包括哪些信息，把文档放在哪里，以便其他人可以找到它，以及在文档中面向的是哪些类型的读者。
+- 该项目是最近才转为内源项目的，主办团队对内源的经验有限。因此，现有的文档解决了很多技术方面的问题。它不包括沟通、协调、促进透明规划所需的信息。
+- 该项目是最近才转化为内源项目的。因此，很多存在于团队中的隐性知识既没有被写下来，也没有对贡献者可见。
+- 文档的缺乏导致潜在的贡献者需要很长时间来设置环境和开始入门。制作文档（并保持更新）需要时间投资。即使东道主团队依靠贡献者的帮助来解决缺乏文档的问题，这些贡献仍然需要时间来评审。


这里”设置环境和开始入门“我倒是想不到更合适的翻译。

host team需要统一一下翻译，比如“东道主团队”还是“主办团队”更好。

改成了 ‘很长时间来设置环境和入门学习’，使用‘东道主团队’

sunzhh02 · 2022-12-31T05:23:48Z

+- 该项目是最近才转化为内源项目的。因此，很多存在于团队中的隐性知识既没有被写下来，也没有对贡献者可见。
+- 文档的缺乏导致潜在的贡献者需要很长时间来设置环境和开始入门。制作文档（并保持更新）需要时间投资。即使东道主团队依靠贡献者的帮助来解决缺乏文档的问题，这些贡献仍然需要时间来评审。
+- 项目成员要花大量的时间来回答入门问题。维护一个可以被认为是支持问题的综合数据库需要大量的时间和精力。
+- 组织内的不同团队对于如何格式化源代码和使用何种软件模式有不同的标准。因此，贡献往往最终被重写到很大一部分，甚至完全重写。将所有这些操作标准化并执行这些标准，需要大量的时间和工作。


”因此，贡献往往最终被重写到很大一部分，甚至完全重写。“建议修改为”“因此，贡献通常最后会被大幅甚至全部重写。”

改为 “因此，贡献通常最后会被大幅修改甚至全部重写。”

sunzhh02 · 2022-12-31T05:44:48Z

+- 项目成员要花大量的时间来回答入门问题。维护一个可以被认为是支持问题的综合数据库需要大量的时间和精力。
+- 组织内的不同团队对于如何格式化源代码和使用何种软件模式有不同的标准。因此，贡献往往最终被重写到很大一部分，甚至完全重写。将所有这些操作标准化并执行这些标准，需要大量的时间和工作。
+- 重复解释和重写的额外工作削弱了内源方法的效用。
+- 由于额外的工作和重写造成的延迟而频繁问题升级，导致了一个大奶酪的局面。


Frequent escalations due to extra work and delays due to re-writes看起来可以翻译为 “由于额外的工作而导致的频繁升级以及由于重写而导致的延迟

此外，大奶酪局面能加个括号解释一下么，比如”大的问题“？

sunzhh02 · 2022-12-31T06:38:15Z

-## Known Instances
-
-* Europace AG - See blog post [InnerSource: Adding base documentation](https://tech.europace.de/post/innersource-base-documentation/)
+如果对做出贡献的步骤的解释过于复杂，可以创建一个单独的`CONTRIBUTING.md`文档。这个文件应该回答贡献者过去经常问到的问题。没有必要在前面提供一本全面的书。相反，分享贡献者所需要的信息。它可能会涉及到以下一个或多个主题。


建议“没有必要在前面提供一本全面的书。”改为“没有必要预先提供全面的书籍。”

建议”分享贡献者所需要的信息“改为”分享已证实的为贡献者所需要的信息“

“分享已证实的为贡献者所需要的信息” 改为 “分享已证实为贡献者所需要的信息”

sunzhh02 · 2022-12-31T06:40:13Z

-* Europace AG - See blog post [InnerSource: Adding base documentation](https://tech.europace.de/post/innersource-base-documentation/)
+如果对做出贡献的步骤的解释过于复杂，可以创建一个单独的`CONTRIBUTING.md`文档。这个文件应该回答贡献者过去经常问到的问题。没有必要在前面提供一本全面的书。相反，分享贡献者所需要的信息。它可能会涉及到以下一个或多个主题。
+
+* 如何从版本控制中签出项目的源代码。


“签出”不知是否准确。

“check out” 翻译为“签出”，这个还是符合行业描述。

sunzhh02 · 2022-12-31T06:41:43Z

+* 如何构建项目。
+* 如何运行测试以确保上述修改没有引入新的错误。
+* 如何将你的修改提交给项目。
+* 一些关于所做修改的预期周转时间的信息。


建议翻译为“关于所作修改的预期周转时间的一些信息”

已采纳。

sunzhh02 · 2022-12-31T06:43:18Z

+![CONTRIBUTING.md](../../../../assets/img/standard-base-documentation/CONTRIBUTING-for-contributors.png)
+
+在各种开源项目中，有许多关于如何写 "README.md "和在 "CONTRIBUTING.md "文件中包含何种信息的好例子。
+诸如[如何写好readme](https://m.dotdev.co/how-to-write-a-readme-that-rocks-bc29f279611a)的页面。


这里句号应该是逗号？

已修改。

sunzhh02 · 2022-12-31T06:52:21Z

+在各种开源项目中，有许多关于如何写 "README.md "和在 "CONTRIBUTING.md "文件中包含何种信息的好例子。
+诸如[如何写好readme](https://m.dotdev.co/how-to-write-a-readme-that-rocks-bc29f279611a)的页面。
+[来自GitHub的开源指南](https://opensource.guide/)以及[生产开源](https://producingoss.com/en/producingoss.html)
+都有关于提供什么样的信息的宝贵信息。虽然《生产开源》一书中没有关于写好README本身的章节，但[入门章节](https://producingoss.com/en/producingoss.html#starting-from-what-you-have)确实提供了一份相当广泛的清单，列出了东道主团队成员、用户和贡献者需要的东西。InnerSource项目很可能不会从一开始就涵盖所有这些方面，该清单本身对于启发我们可以涵盖的内容是有帮助的。


host team需要统一一下翻译，比如“东道主团队”还是“主办团队”更好。

该清单本身对于启发我们可以涵盖的内容是有帮助的。建议翻译为“该清单本身对于启发我们可以涵盖何种内容是有帮助的。”

已采纳。

sunzhh02 reviewed Dec 31, 2022

View reviewed changes

WillemJiang added 5 commits December 31, 2022 20:33

Added translation of base-documentation

4faf1af

Fixed the broken link error of base-documentation

ed61fa2

Fixed the broken links of base-documenetation

b4d1c24

Update the translation with review comments

c48e667

Update the gitbook toc

f3bd83f

WillemJiang force-pushed the base-documentation branch from 14aae0e to f3bd83f Compare December 31, 2022 12:37

WillemJiang merged commit 28847ba into translation-cn Dec 31, 2022

WillemJiang deleted the base-documentation branch December 31, 2022 12:39


		## 上下文

		一个项目要作为一个内源项目与他人分享。为了让其他人能够理解项目的内容以及如何做出贡献，项目需要提供一些基本的文件。到目前为止，该项目要么缺乏所有的文档，要么缺乏用户以自我服务的方式进行尝试以及贡献者快速上手所需的某些方面的内容。


		## 约束

		- 该项目最近才转为内源项目。以前，用户要么是内部的，要么是在个人面对面的会议上加入进来的。同样，在项目中工作的人员也是通过个人入职指导加入到项目中，而这种入职指导并不能随着贡献者或远程贡献者人数的增加而扩大。因此，自我服务文件是缺乏的。

Conversation

WillemJiang commented Dec 28, 2022

Uh oh!

sunzhh02 Dec 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sunzhh02 Dec 31, 2022 •

edited

Loading