维护程序员维基 [英] Maintaining a Programmer Wiki

问题描述

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

I was recently put in charge of the wiki for the development team. The wiki is still in its infancy, so I have a lot of room to work with. It goal is to house internal to the development team. Currently, the main piece of information that the wiki holds is Coding Standards.

• 您的开发团队在其内部 wiki 中使用了哪些最佳实践?
• 开发维基上有哪些重要信息?
• 如果您要访问开发团队的 wiki，您希望看到什么信息?
• 是否有一些信息即使看起来是个好主意也不应该放在 wiki 上?

-- 编辑 --

• 另外，有没有什么好的方法来组织信息?(例如按层(数据，ui)，按项目，或其他)

推荐答案

• 面向新程序员的源代码库介绍
• 一般文档(不是 API 文档本身，而是更多教程之类的东西)
• 员工名单/谁在做什么以及如何联系他们
• 说明软件中使用的概念的注释/资源/文章
• 构建过程的文档和代码库的文件系统布局

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

Other things I usually put up there are

• 计划/待办事项列表
• 其他人可以阅读有趣的信息
• 我认为应该分享的所有其他内容

这篇关于维护程序员维基的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！