documentation - 让开发人员使用 wiki

标签 documentation wiki mediawiki

关闭。这个问题是opinion-based .它目前不接受答案。












想改进这个问题?更新问题,以便 editing this post 可以用事实和引用来回答它.

4年前关闭。




Improve this question




我在一个复杂的应用程序上工作,不同的团队在他们自己的模块上工作,并有一定程度的重叠。不久前,我们设置了一个 Mediawiki 实例,部分是在我的提示下。我很难让人们真正使用它,更不用说贡献了。

我可以看到分享信息的很多好处。它至少可以减少我们重新发明轮子的次数。

wiki 不是很结构化,但我不确定这是否是一个问题,只要您可以搜索您需要的内容。

有什么提示吗?

最佳答案

一些技巧:

每当有人通过电子邮件发送真正应该在 wiki 中的信息时,为该主题创建一个页面并添加他们在电子邮件中输入的内容。然后回复“感谢您提供的信息,我已将其放入此处的 wiki,以便将来更容易找到。”

同样,如果您有需要分享的信息应该在 wiki 中,请将其放在那里,然后发送一封带有链接的电子邮件,而不是向他人发送电子邮件。

当您向人们询问信息时,请这样说,以便将此类文档放在 wiki 中应该被视为默认或标准:“我在 wiki 中搜索但找不到它。你把那个信息放在那里了吗?”

如果您是“维基冠军”,请确保其他人知道如何使用它,例如“我和你讨论过如何创建一个新页面了吗?”

编辑侧边栏以确保它与您的工作相关。

在相关页面上使用“导航框”样式模板,以便于导航。

将 {{Special:NewPages/5}} 之类的内容放在首页或最近的更改中,以便人们可以看到事件。

每隔几天或每周查看一下最近的变化,如果您发现有人在没有被催促的情况下添加信息,请给他们发送电子邮件或顺便拜访并给他们一点赞美。

关于documentation - 让开发人员使用 wiki,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/15871/

相关文章:

javascript - 如何为 GitHub Pages 生成 JavaScript API 文档

android - 构建本地单元测试(未注册仪器!必须在注册仪器下运行)

javascript - ESDoc 将我的所有模块方法放在一个标题下,而不是每个文件下,我如何更改此行为?

c# - 缺少 WCF 服务的 xml 注释的编译器警告

c# - 在 C# 中转换或解析 wiki

mediawiki - 了解维基媒体转储

integration - DokuWiki 与 mantis 集成失败

Wiki 上的 Github 语法高亮

html - 如何确保可折叠表格后面的文本显示在其下方,而不是右侧?

json - 使用 API 搜索维基百科