介绍新程序员的源代码库

一般文档（不是 API 文档本身，但更多的教程一样的东西）

员工名单 / 谁在做什么以及如何联系他们

说明软件中使用的概念的注释 / 资源 / 文章

构建过程的文档和代码库的文件系统布局

我通常在那里放的其他东西是

计划 / 待办事项列表

其他人阅读的有趣信息

其他一切，我觉得应该分享

我们有一个开发 wiki，它是一个很棒的工具。我们把它用于一切！

当集思广益时，我们会在 wiki 上捕获它们。wiki 的低摩擦特性使组织中的任何人 (我们是一家小型初创公司) 都可以很容易地在他们想到的时候添加想法。我们有一个高级别的“头脑风暴”页面，它链接到详细的页面，其中包含对每个想法的全面描述。

对于每次迭代，我们都会将功能想法项目从“头脑风暴”列表中“移动”到该迭代的功能列表中。

随着功能的完成，迭代页面变成了我们的发行说明页面-其中还包括来自版本控制系统的发布标签。

我们有一个 bug 页面，它的工作方式与功能页面非常相似。错误修复被添加到迭代 / 发布页面，因为它们在 / complete 上工作。

我们还在 wiki 上创建了我们的用户文档，并在发布时导出了这些页面。

随着时间的推移。这个工具被认为越来越有价值。我们最终为公司正在开发的不同产品创建了新的 wiki。

我希望你发现你的开发 wiki 和我们一样有用！

Wikipatterns是一个致力于记录最佳 wiki 实践的网站。他们还描述了反模式并讨论了应对方法。我读了他们的书，对我来说，在一个 150 多人的组织中启动 wiki 是一笔巨大的财富。

我们在开发 wiki 上强调的一件事是，当情况发生变化时，它会更新。我们不希望旨在提供信息并成为收集知识的中心来源的 wiki 变得过时以至于无用。随着代码的更新，要求开发人员更新 wiki 上的任何相关信息。

除了编码标准之外，我们还保留了使用代码库，为新员工设置信息以及一般环境信息的提示和技巧。