作为Hacktoberfest季的一部分，现在是一个很好的时机来考虑如何让开源存储库成为开发人员和最终用户的欢迎空间。促进贡献和扩大用户群的一个很好的方法是在整个开发周期中提供文档并鼓励对文档进行增强。在考虑文档时，要把它作为开源实践的一个基本部分：尽早、经常地提交文档。与您的合作者一起开发类似代码的文档，在编写功能之前对其进行文档化，并在开发过程中记录代码。这将使代码库更加连贯一致的开发人员谁可能在你的项目，以及你的未来自己！在包含在编程文件中的文档中要慎重，不要做得太多。可读并遵循相关样式指南的代码通常可以在提供上下文或解释不明显的方法的过程中使用一些注释来说明自己。如果在一个编程文件中添加了太多的文档，可能会使代码更难阅读。像对待其他人一样对待代码（因为它会被其他人阅读），并认真地进行评论。就像软件项目中的其他一切一样，文档也需要测试和维护。修改代码时，养成编辑注释和相关文档的习惯。继续迭代文档和其他所有内容，减少在接近发布时进行文档推送的需要。包括以社区为中心的文档当您准备好通过开放源代码存储库与更广泛的世界共享软件时，请确保您的项目可以通过包括提供软件描述的关键文件、为贡献者提供的指导方针和激励措施、以及为开发人员和最终用户提供的教程来实现。下面是您希望确保包含的文件，以及GitHub上提供的开放源代码存储库中这些文件的示例。一个``[php]{`自述文件.md`}```描述项目及其目标的文件；GitHub会自动初始化它，但一定要充实它EduBlocks自述文件组织良好，既有可视屏幕截图说明，也有手动说明，在这个中心位置a``[php]{`贡献.md`}```为潜在的贡献者提供说明的文件-这有助于开发人员了解在项目中进行协作的最佳方式"为JupyterLab贡献"为贡献者提供了全面的指导方针和额外的资源（可选，您可以考虑）包括一个``[php]{`代码_样式.md`}```curl提供了一个很好的示例a``[php]{`code\_行为医学博士`}```提交一份声明，反映项目的社区价值观，并为维护者和贡献者设定期望值TensorFlow行为准则，改编自几个来源，包括贡献者契约，大数据行业前景，详细说明了标准、责任，并提供了解决冲突以及如何报告违规行为的指南a``[php]{`贡献者.md`}```或"`[php]{`作者.md`}```申请认可贡献者，这将有助于您欢迎和激励社区参与Calagator提供了这类文件的一个典型示例，其中包含按字母顺序排列的贡献者列表以及从repo的"`[php]指向此文档的链接{`自述文件.me`}```文件，以支持最终用户，云服务市场，考虑包括教程风格的文档，提供如何使用软件的指导。在编写教程时，要考虑谁是您的目标受众，以及您的实际受众可能是谁。当你是你的项目专家时，把你的文档写得好像你是第一次使用你的软件的初学者一样。如果你有足够的资源，物联网工程是什么，可以考虑做一些用户测试来观察新用户与软件的交互，这样你就可以确保他们能够以有意义的方式使用你的软件所需要的支持。鼓励文档贡献一个人可以对开源存储库做出的最重要的贡献之一就是文档更新。对于新兴的开发人员来说，根据他们使用工具的经验改进现有文档的拉式请求提供了一个进入开源领域的入口。创建一个让人们在代码和文档贡献方面得到同等认可的环境，中移物联网有限公司，对于围绕项目构建社区有很大帮助。对于接近代码的人来说，完全理解新贡献者或最终用户的需求可能是一个挑战。通过鼓励不同声音对您的文档做出贡献，您的项目将反过来对更多的人变得更有用，从而使它能够覆盖更广的范围观众。努力使文档具有包容性和可访问性，并从其他人的角度出发，也可以支持将更多的开发人员和最终用户带到您的软件中。你可以做的一些事情来促进参与度包括：使用欢迎和无偏见的语言，提供更好的自然语言翻译，以更好地服务于分布式社区确定你的读者的最佳阅读水平参考基于文本的教程的替代品，整合音频和视频组件可能有助于其他人更好地了解屏幕阅读器的文档优化确保基于web的教程是完全兼容的。您可以做很多事情来使项目文档在社区中更具包容性。欢迎其他人作为文档协作者，可以帮助您满足更多人的需求，从而可以扩展项目。为了了解更多关于技术文档的信息，大数据数据，writethedocs社区拥有全面的资源，并提供了与其他从事文档和开源工作的人联系的机会。您可以通过查看我们的"开放源代码简介"系列教程来阅读更多关于贡献开源和维护存储库的信息。Hacktoberfest现在开始，将持续到10月31日。Lisa Tagliaferri是数字海洋社区团队的成员。您可以在我们的社区站点上找到2000多个关于DevOps、开发和开源的教程。在Twitter@lisaironcutter上关注Lisa。