¶ 美萌Wiki中心
嗨！欢迎来到美萌WIKI中心！
美萌WIKI中心旨在为软件开发项目提供全面的文档资料信息。通过wiki中心维护公司所有项目的包括项目计划、需求规格、技术文档、API文档、用户手册等，以满足在开发、维护过程中的各种需求。
让我们一起探索、学习和成长，在美萌WIKI中心共同建设一个优秀的软件文档社区！
¶ 概述
¶ 为什么项目wiki很重要?
项目的 Wiki（维基）在项目管理和团队协作中扮演着重要的角色，具有以下几个方面的重要性：
-
知识管理：项目的 Wiki 是一个集中存储和组织项目相关知识和信息的平台。它可以包含项目的需求文档、设计文档、技术文档、操作手册、规范、流程说明等。通过维护一个完善的 Wiki，团队成员可以方便地查找和获取项目相关的知识，避免信息孤岛和重复劳动。
-
文档共享和协作：Wiki 提供了一个团队成员之间共享和协作文档的中心化平台。团队成员可以在 Wiki 上创建、编辑和更新文档，提供反馈和评论，并进行版本控制和协同编辑。这有助于团队成员共同编写和维护文档，促进信息的共享和协作。
-
学习和培训：项目的 Wiki 可以作为学习和培训的重要资源。新成员加入项目时，可以通过查阅 Wiki 上的文档快速了解项目的背景、目标、规范和工作流程。同时，团队成员也可以将自己的经验和教训记录在 Wiki 上，供其他成员参考和学习。
-
项目历史和回顾：Wiki 记录了项目的演进和历史。团队成员可以查阅过去的文档和讨论，了解项目的决策和演化过程。这对于项目的回顾、复盘和持续改进非常有价值，有助于避免重复错误、学习经验教训，并为未来的项目提供参考。
-
知识传承和团队稳定性：项目的 Wiki 在团队中起到知识传承的作用。当团队成员离开或新成员加入时，他们可以通过查阅 Wiki 上的文档快速获得项目相关知识，减少对个别成员的依赖，提高团队的稳定性和可持续性。
¶ 为什么要弄这样一个管理平台
在没有统一维护平台时。开发人员如何维护项目wiki信息。
- 写在代码git仓库的readme中
- 本地记事本
- 各种线上文档平台(腾讯文档、飞书文档等)
- 更有甚者，直接不写
由此可见。由于没有统一标准，导致文档管理异常混乱。不仅仅无法完成上述文档管理的目的。也潜在的加深了项目持续迭代维护的风险。比如本地记录员工电脑顺坏或是离职后没有详细交接。导致项目资料丢失。严重的话可能导致生成发布风险。
为了解决这些风险。所以我们需要一个这样的平台。
¶ 开始
想要在wiki中心管理项目资料。你需要知道以下一些信息。首先，wiki文档中心用于提供一些通用文档供你阅读。并且主要用于项目资料的维护。
关于一些技术文档，你可以结合文档平台一起使用。会有更好的效果。
¶ 开发规范入口
¶ 账户创建
针对项目型的文档。通常来说需要提供有限的权限访问。所以，需要账户权限体系来进行管理。Wiki提供了开箱即用的权限管理机制。我们根据这个机制设计了一套项目wiki规范。并要求所有人遵守。
wiki开放了注册选项。你可以通过登录页面的注册选项创建一个账号。
目前支持
@weimob.com@qq.com的邮箱注册。 如果你没收到邮件。请前往垃圾邮箱查一下~~
点击注册会通过163邮箱给你发送一封验证邮件。请登录邮箱进行验证即可成功注册。当你注册成功后。
可以进行登录访问公共的wiki文档~
如果无法激活。请联系管理员(胡祥)手动激活认证账户
¶ wiki管理规范
管理规范定义总结了一套适合公司交付体系的规则。通过这些规范要求。能够尽可能的保证wiki文档的统一性、可维护性以及扩展性。
所以请所有开发人员务必仔细阅读并遵守。
¶ wiki的管理
在使用本站点前。我们强烈建议你读完官网处的用户手册。这样你会对本站点有一个初步的认识
在完成阅读后。我们需要明确几个概念:
-
项目wiki是根据员工平台立项项目进行隔离的。这样的好处是能够精准的控制用户权限
-
相同项目分期迭代立项不要重复创建wiki。比如三星项目，首次创建了一个
LX0001-sanxingwiki。后续项目继续迭代P1、P2...PN。在员工平台上不要重复创建。请都在LX0001-sanxingwiki中进行维护 -
项目wiki地址基于路径管理。不存在目录的概念。即通过约定路由构建目录。当你具有本项目wiki权限。你可以创建多个wiki文档
-
你可以在有权限的项目wiki下创建多个文档或者统一使用首页文档进行管理。这个完全取决于你。
-
当然我们也推荐一些固定的规范:
public-xx是开放wiki。如果有些资料你需要共享给客户。你可以写在这里面configuration项目配置信息文档depoly项目部署文档resource项目资源文档
¶ assets 静态资源管理
wiki文档除了文本内容。通常你还需要维护图片、视频、PDF文件等。本站点也相应提供了上传资源的方式。
- 在文章编辑页面。选择上传图片。创建一个资源文件夹
- 为了保证资源的权限可控。我们也设计了类似wiki页面权限相同的规则。你只可在页面路径文件夹下上传管理静态资源。比如你的wiki路径是
LX0001-sanxing/home。那么相对应的assets文件夹路径为lx0001-sanxing。 注意首字母是小写的
如果你不知道。可以看一下浏览器地址栏。将你的项目路径复制出来。并将首字母两个大写改成小写即可
这样你就拥有了一个同名目录来管理你的静态资源了
¶ wiki项目创建/授权
这一段是提供给总监/经理阅读。
目前员工平台已经接入wiki创建与管理。可以无需手动执行这些步骤。当然如果你对创建过程好奇。它做了什么事情。可以继续阅读
对于立项项目。项目管理员(通常是你的部门经理或者总监)需要在项目立项后创建项目wiki。并给相应的人员赋予权限。这里我们详细讲述一下
¶ 创建用户组
在 管理-组 创建用户组
请注意组名称规则必须遵循 立项号-项目拼音 规则.即 LX00000-pinyin
¶ 给项目成员赋予项目组权限
- 设置用户组权限
在组详情-PERMISSIONStab栏下。勾选:read:pages write:pages mamage:pages read:assets write:assets mamage:assets read:comments write:comments
- 设置用户路径权限
首先勾选第一组权限。具体为 与上述一致。具体看下面的截图
其次还需要设置路径。路径规则与组名称保持一致
- 用户路径权限
- 添加用户
最后添加用户。可以搜索名称、邮件进行添加。将项目组成员添加进组内
¶ 创建项目wiki
设置完成权限后。该组成员即可创建 LX000-{name} 路径规则下的文章。进行项目wiki的创建维护。
建议使用wiki模板创建
done！！ 至此。项目wiki创建完毕
