Skip to content

里程碑规划

这份里程碑规划文档,用来定义当前仓库 VitePress 站点重构项目的执行顺序、交付物和当前状态。

项目目标

把当前仓库中大量分散的 Markdown 资料,逐步整理成一个具备下面这些特征的知识站点:

  • 能自动接入新增 Markdown 内容
  • 能按模块、目录和重点专题清晰导航
  • 能在历史资料脏数据存在的前提下稳定构建
  • 能持续演进首页、模块入口、搜索与阅读体验
  • 有完整的过程文档与交付记录

里程碑总览

M0:站点底座落地

目标:先把仓库资料重构成可以实际跑通的 VitePress 站点。

交付物:

  • package.json
  • scripts/generate-vitepress.mjs
  • 自动生成的 docs-site 站点镜像能力
  • 可运行的 npm run dev / npm run build / npm run preview

当前状态:已完成。

M1:首页与模块导航增强

目标:在站点可跑通的基础上,补齐首页信息架构、模块推荐区、模块总览页和更适合阅读的导航展示。

交付物:

  • 首页增强版
  • 模块总览增强版
  • 对应任务拆解文档
  • 对应详细设计文档
  • 对应开发记录文档

当前状态:已完成。

M2:专题入口与推荐阅读增强

目标:从“按目录浏览”继续走向“按主题浏览”,为高价值内容补齐专题入口与推荐阅读链路。

交付物:

  • 专题导航/ 总览页
  • 多个专题详情页
  • 首页专题推荐区
  • 对应任务拆解文档
  • 对应详细设计文档
  • 对应开发记录文档

当前状态:已完成。

M3:站点体验与发布能力增强

目标:继续补齐搜索、SEO、构建性能与部署能力,让站点更接近正式可发布状态。

候选方向:

  • 搜索体验优化
  • 构建告警治理
  • 发布脚本或 CI
  • 站点元信息和社交分享优化

当前状态:已完成。

M4:首页表达与重点阅读路径增强

目标:继续提升站点首页和导航总览页的表达质量,让读者不仅能找到内容,还能知道“先看什么、怎么开始看、最近哪里有变化”。

候选方向:

  • 首页可视化信息增强
  • 最近更新视图
  • 重点阅读路径设计
  • 模块页与专题页的推荐展示增强

当前状态:已完成。

M5:内容质量治理与校验链路增强

目标:在站点已具备导览能力的基础上,继续补齐 Markdown 质量巡检、治理视图与 CI 校验,让知识站更适合长期维护。

候选方向:

  • 标题与命名质量巡检
  • 资源缺失与占位页统计
  • 站点治理总览页
  • PR / 分支构建校验链路

当前状态:已完成。

M6:治理优先级与质量基线增强

目标:在站点已具备治理总览的基础上,继续补齐热点模块优先级、质量基线和回归校验,让治理开始形成闭环。

候选方向:

  • 治理热点模块排序
  • 质量基线文件
  • 构建后回归比较
  • CI 巡检结果归档

当前状态:已完成。

M7:治理落地试点与趋势对比增强

目标:在已有治理总览与质量基线的基础上,继续推进一次真实的治理落地试点,并把治理结果以趋势方式展示出来。

候选方向:

  • 缺少一级标题批量修复试点
  • 治理结果对比基线展示
  • 模块治理方法沉淀
  • 更优质量基线回写

当前状态:已完成。

M8:治理扩面与修复清单增强

目标:在 M7 已完成治理试点后,把标题治理扩展到更多中等体量模块,并让治理页开始显示更清楚的修复清单。

候选方向:

  • 多模块标题治理扩面
  • 修复清单展示增强
  • 治理节奏开始可复制
  • 更优质量基线回写

当前状态:已完成。

M9:治理继续扩面与修复明细增强

目标:在 M8 已完成多模块治理扩面后,继续把标题治理推进到 React 学习模块和热点大模块中的可控子目录,并让治理页展示累计治理清单。

候选方向:

  • 12React学习 标题治理扩面
  • 00面试相关整理/2024面试准备 子目录试点
  • 累计治理清单展示
  • 新一轮质量基线回写

当前状态:已完成。

M10:热点子目录治理扩展与推荐视图增强

目标:在 M9 已完成热点模块子目录试点后,继续把治理节奏扩展到跨模块子目录,并增强治理页的推荐视图,让下一步拆解更细。

候选方向:

  • 跨模块热点子目录治理
  • 本轮治理范围表达增强
  • 子目录级推荐视图增强
  • 新一轮质量基线回写

当前状态:已完成。

M11:大体量子目录治理与里程碑视图增强

目标:在 M10 已验证跨模块子目录治理节奏后,继续推进更大体量的热点子目录治理,并让治理页开始按里程碑表达阶段进展。

候选方向:

  • 大体量热点子目录治理
  • 同模块连续多轮子目录治理
  • 治理里程碑视图增强
  • 新一轮质量基线回写

当前状态:已完成。

M12:资源巡检降噪与资源治理试点

目标:在连续多轮标题治理后,把治理链路扩展到资源问题,并先解决资源巡检误报过多的问题,再推进小范围资源修复试点。

候选方向:

  • 资源巡检误报降噪
  • 资源问题页推荐视图
  • 小范围资源修复试点
  • 新一轮质量基线回写

当前状态:已完成。

M13:资源治理收口与示例表达校正

目标:在 M12 已把资源巡检做得可用之后,继续清理剩余资源问题,把示例型内容从“被当成真实资源”调整为“明确的代码示例”,并完成资源问题收口。

候选方向:

  • 剩余资源问题清零
  • 示例型 HTML 片段表达校正
  • 历史缺图页收尾修复
  • 新一轮质量基线回写

当前状态:已完成。

M14:标题治理扩面与热点子目录再推进

目标:在资源问题已收口后,把治理重点重新切回标题缺失,并继续以热点子目录为单位推进一轮更大范围的标题治理扩面。

候选方向:

  • 热点标题缺失子目录治理
  • 跨模块继续复用批量修复脚本
  • 治理页本轮范围与里程碑继续扩展
  • 新一轮质量基线回写

当前状态:已完成。

M15:标题治理继续扩面与知识型目录推进

目标:在 M14 已再次验证热点子目录标题治理节奏后,继续把治理范围扩展到知识型目录,进一步压降标题缺失总量。

候选方向:

  • 知识型目录标题治理扩面
  • 多层目录结构下继续复用修复脚本
  • 治理页本轮范围与里程碑继续扩展
  • 新一轮质量基线回写

当前状态:已完成。

当前推荐执行顺序

建议按下面顺序持续推进:

  • 先有里程碑规划
  • 再有某一轮任务拆解
  • 再补详细设计
  • 再做功能开发与自测
  • 最后补开发记录 / 技术博客并提交推送

当前阶段

当前阶段:M0 已完成 + M1 已完成 + M2 已完成 + M3 已完成 + M4 已完成 + M5 已完成 + M6 已完成 + M7 已完成 + M8 已完成 + M9 已完成 + M10 已完成 + M11 已完成 + M12 已完成 + M13 已完成 + M14 已完成 + M15 已完成,待进入下一轮迭代。

当前完成标准

判断当前某一轮是否真正完成,可以看下面这些条件是否都满足:

  • 对应功能已经落地
  • npm run build 已通过
  • 关键页面预览访问已通过
  • 对应任务拆解文档已完成
  • 对应详细设计文档已完成
  • 对应开发记录文档已完成
  • Git 提交与推送已完成

共 20 个模块,1301 篇 Markdown 文档。