夜雨聆风
Repo Wiki(项目文档管理得力助手)
•核心定义
-
Git托管平台（GitHub/GitLab/Gitee）轻量化协作工具 -
项目「说明书+知识库」，关联代码仓但独立管理 -
非技术人员友好，无需复杂代码操作
•核心特点
-
关联独立：仓库附属模块，独立入口；Markdown编辑，即时生效；比README.md更灵活 -
协作可控：多权限编辑，自动记录修改历史，支持版本回滚；多页面+目录，构建结构化文档体系 -
轻量易访：在线直接查看，无需下载/装软件；适配多类文档存储需求
•与README.md核心区别
-
Repo Wiki：完整知识库，长篇结构化；多页面可扩展；在线可视化编辑，非技术人员可操作；存详细文档/协作规范/用户手册 -
README.md：仓库首页简短介绍；单一文件，内容忌长；手动写Markdown，开发人员维护；存核心信息/快速安装/简易使用方法
•实操步骤（以GitHub为例）
-
进入：打开仓库，点击顶部「Wiki」选项卡 -
建首页：首次使用点「Create the first page」，Markdown编写核心内容 -
加新页：点「New page」，输入标题/内容，支持子目录命名（如docs/API-说明） -
管页面：在「Pages」中调整排序、重命名、删除页面 -
控权限：管理员在「Settings → Manage access」设置编辑权限，默认与仓库一致
•适用场景
-
开源项目：提供详细使用/API/排障文档，降低用户上手成本 -
内部项目：存储开发规范/部署流程/测试用例，减少沟通成本，助力新人熟悉 -
嵌入式/硬件项目：记录工具使用/通信调试/硬件接线等技术细节，沉淀实操知识
