首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >组织应用程序开发团队wiki?

组织应用程序开发团队wiki?
EN

Software Engineering用户
提问于 2012-09-07 02:05:31
回答 2查看 2.5K关注 0票数 9

寻找为开发人员设置wiki的最佳实践结构?

我将管理一个在文档、沟通和知识共享方面没有最好记录的团队。我希望建立一个框架,使团队更容易在这一领域起步。

EN

回答 2

Software Engineering用户

发布于 2012-09-07 04:56:50

首先,选择一个好的Wiki是很重要的。选择一个:

  1. 维护良好,有良好的支持。
  2. 支持用户身份验证,并对文档或命名空间具有访问控制。
  3. 跟踪文档的更改并提供历史记录。
  4. 允许电子邮件通知文档更改。
  5. 有一个好的编辑器,最好是WYSIWYG,并支持列表,表格和上传图像。

Wiki开发团队最需要的是“园丁”:负责确定Wiki中文档的布局和结构的人。它不一定是一个全职的角色,但园丁应该有很强的英语能力和才能很好地解释事情。园丁应该为页面、命名约定创建标准模板,并确定所需的名称空间。

园丁不负责创建内容,更多地执行其结构。例如,如果有人对产品进行了更改,则园丁不负责对Wiki进行更改。然而,园丁有责任确保更改是根据指南进行的(例如,不只是附加到一个单独的、未链接的页面)。园丁可以检查变更或委托给其他人。

重要的是构建Wiki以满足受众的需求,而不是那些创建内容的人的需求。例如,如果您有一个专门用于软件开发的UI或安全或本地化团队,请不要将它们的信息放在单独的部分中。将它们放在开发人员正在查看的同一区域。把所有的东西放在一起可以让你更容易找到东西,确保东西不会被错过,并且能更快地识别过时的内容。

Wiki需要改变思维方式。许多公司习惯于被强加在他们身上的信息。Wiki允许信息的使用者修改它。这应该得到大力鼓励(如果需要的话,也应该给予奖励)。如果不准确是一个问题,让审查员将Wiki配置成修改后的电子邮件。

开发Wiki需要一个策略来处理版本控制。如果您有一组1.0版本的文档,那么当版本2.0发布时会发生什么呢?1.0版的一些文档可能仍然适用于2.0,但有些文档可能被取代。如果在2.0发布后对1.0文档进行了更改,该怎么办?

Wiki需要一些衡量成功的方法。有多少人在使用它?他们找到他们要找的东西了吗?你不一定需要一个大的,难看的评级和评论框在页面底部,但一个简单的“电子邮件关于这个页面的人”的链接可能是有帮助的。

最后,Wiki的使用模式将随着时间的推移而改变。记住定期检查任何标准,以确保它们仍然满足Wiki的需求。

票数 4
EN

Software Engineering用户

发布于 2012-09-07 03:19:27

虽然所有项目wiki页面都遵循一个类似的主题,这样每个人都知道在哪里可以找到东西,这是一个好主意,但这并不能真正解决开发人员不更新页面的问题。

您需要找到一种方法,让您的开发人员在做这些事情时看到足够的好处--他们驱动它并希望它完成。否则,他们只会把它看作是另一个自上而下的官僚负担。

我在这种情况下,无论是维基是一个完整的混乱,它是高度组织化和正式的。维基的状态并没有影响开发人员的兴趣水平。

票数 1
EN
页面原文内容由Software Engineering提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://softwareengineering.stackexchange.com/questions/164010

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档