维护程序员Wiki

Question

我最近负责开发团队的wiki.维基仍处于起步阶段,因此我有很大的工作空间.它的目标是为开发团队提供内部服务.目前,维基所拥有的主要信息是编码标准.

• 您的开发团队为其内部维基使用的最佳实践是什么？
• 在开发维基上有哪些重要信息？
• 如果你要去开发团队的wiki,你期望看到什么信息？
• 是否有一些信息不应该出现在维基上,即使它似乎是一个好主意？

- 编辑 -

• 此外,有没有一种很好的方式来组织信息？(例如通过图层(数据,ui),按项目或其他方式)

Answer 1

• 介绍新程序员的源代码库
• 一般文档(不是API文档本身,而是更多教程)
• 工作人员名单/谁在做什么以及如何接触他们
• 解释软件中使用的概念的注释/资源/文章
• 构建过程的文档和代码库的文件系统布局

我通常会提到的其他事情

• 计划/待办事项列表
• 其他人有兴趣阅读的信息
• 我觉得应该分享其他一切

Answer 2

我们有一个开发维基,它是一个很棒的工具.我们用它来做一切!

• 在集思广益的新想法时,我们会在维基上捕捉它们.wiki的低摩擦性使得组织中的任何人(我们是一家小型创业公司)都可以轻松地添加想法.我们有一个高级别的"头脑风暴"页面,该页面链接到包含每个想法的详尽描述的详细页面.
• 对于每次迭代,我们将"头脑风暴"列表中的特征构思项"移动"到该迭代的特征列表中.该功能的详细信息已被刷新,包括设计和实现细节.
• 随着功能的完成,迭代页面成为我们的发行说明页面 - 其中还包括我们的版本控制系统中的发布标记.
• 我们有一个与功能页面非常相似的错误页面.在处理/完成时,错误修复被添加到迭代/发布页面.
• 我们还在Wiki上创建了用户文档,并在发布时将这些页面导出.

随着时间推移.这个工具被认为越来越有价值.我们为公司正在开发的不同产品创造了新的维基.

我希望你发现你的开发维基像我们一样有用!

Answer 3

Wikipatterns是一个专门记录最佳维基实践的网站。他们还描述了反模式并讨论了处理它们的方法。我读了他们的书，在一个 150 多人的组织中建立一个 wiki 对我来说是一笔巨大的财富。