Wiki的最佳实践

这个页面描述了贡献和编辑Digilent wiki内容的推荐的最佳实践。除非下面另有说明，Digilent wiki遵循维基百科风格手册．

命名约定

  • 名称空间
    • 只使用小写字母数字字符和“-”。
    • 使用“-”(破折号)来替换空格。
  • 页面名称
    • 只使用小写字母数字字符和'-'。
    • 使用“-”(破折号)来替换空格。

语气

  • 使用现在时态。
  • 使用祈使语气．
  • 避免直接称呼读者:
    • 坏:你可能认为这将工作，但实际上你需要添加一个停止按钮的while循环。
    • 好:在while循环中添加一个停止按钮。
    • 坏:当你完成时，记得保存。
    • 好:保存文件。
  • 避免不必要的结构:
    • 坏请注意，这自然会在更保守的报纸上引起争议。
    • 好这在较为保守的报纸上引起了争议。

组织

通常很容易将wiki看作是一个文件系统，其中名称空间是文件夹，页面是文件。这在页面中可见URL其中斜杠将命名空间(文件夹)与命名页面(文件)的最后一个元素分开。

例如这一页，/引用/ wiki /开始，是一个名为“start”的文件，位于引用顶级命名空间的“wiki”子命名空间中。

  • 导航页面这些页面主要是为了帮助用户导航。
  • 内容页面是包含供用户消费的内容的页面。
  • 命名空间中的主页应该称为“start”。
    • “开始”页可以是登录页或内容页。
  • 大多数内容页面应该包含在它们自己的名称空间中。这使得页面更容易移动并避免命名冲突。
  • 比起绝对链接，更喜欢相对链接。

内容类型

  • 学习
    • 基本面
      • 基本的工程概念(想想维基百科的文章)，目的是链接或包含在其他页面，以避免重复的内容。
    • 教程
      • 教学内容的设计是高度可复制的，将经常(但不总是)包含使用特定的硬件和软件一步一步的说明。
    • 课程
      • 收集讲座、讨论和实验资料。解决方案可能不会公开。
  • 项目
    • 鼓舞人心的内容，不是设计为高度可复制。鼓励提供源代码和示意图，但不是必需的。
  • 参考
    • 勤勉产品和项目的参考资料。

媒体

  • 图片
    • 图像应该存储在与其显示的页面相同的名称空间中。
  • 源代码
    • 的内联添加小块的源代码
      标签。*项目和大量的源代码应该存储在GitHub中。** *二进制文件** *二进制文件应该托管在一个文件共享服务，如Amazon S3。==== Tagging ==== ----使用[[https://www.dokuwiki.org/plugin:tag | Tag Plugin]]来标记页面。下面是一个标签语法的例子:
  • 标签应放在页面内容之后(底部)。
  • 只使用小写字母数字字符和“-”。
  • 使用“-”(破折号)来替换标签内的空格。
  • 用空格分隔标签。
  • 内容页面应该包括名称空间标记作为标记。