Files
up/PROJECT_REVIEW.md
Leap 离谱and你的名字 d442046074 Upgrade learning guide onboarding and maintenance (#204)
* Upgrade learning guide onboarding and maintenance

* Clarify audit publication status

---------

Co-authored-by: 你的名字 <you@example.com>
2026-10-19 13:08:05 +08:00

12 KiB
Raw Permalink Blame History

项目分析与改进记录(历史快照)

原分析日期:2026-09-19;历史复核日期:2026-10-07,基线为当时的 35e2aa9(origin/main)。本文是历史项目复核快照,其中 GitHub 计数、仓库设置、分支与 PR 状态、依赖和测试结论,以及“本轮处理”,均描述截至 2026-10-07 的状态,不代表当前状态。下方出版文件统计于 2026-10-19 按当前 manifest 与本地文件 SHA-256 复核。

项目定位与现状

项目已经从英语专题演进为中英双语《人生进阶指南》,不是需要重新搭建的空站点。现有六部书稿覆盖英语、人生恢复、AI 协作、日常节律、九十天行动和长期自我成长;VitePress 负责网页,导航同时驱动目录、语言对应、翻页与电子书。保留这条主线,比再建立一套平行课程更有利于读者连续阅读和维护者同步修改。

现有工程基础包括本地搜索、响应式布局、无障碍标签、旧地址兼容、EPUB/PDF 导出、内容质量检查、体积预算和桌面/移动端浏览器测试。主要问题在于新内容如何进入这套体系,以及检查能否持续覆盖它。

GitHub 发现与 Star 转化

2026-10-07 抓取仓库首页时,项目约有 6.7 万个 Star、6,694 个 fork 和 983 个 watcher,说明项目已经拥有很强的历史传播基础。当前更值得优化的是新访客转化和参与回流,而不是继续堆叠章节数量。

对照同样以自学内容为核心的高关注仓库:

项目 首页可借鉴的做法 本项目对应处理
freeCodeCamp 先说明免费学习范围,再直达课程、认证、问题反馈和贡献入口 首屏交代书稿、下载、工作表与反馈方式
Coding Interview University 先说明目标读者和学习计划,再给使用方法与练习路径 按五分钟、十四天和九十天展示不同投入尺度

这些是信息组织方式的对照,不是 Star 增长的因果证据。上线后可按月核对仓库访问、主页点击、Issue 类型和读者实践回执,观察新入口是否真的帮助读者开始并反馈;没有足够样本时不把单月 Star 变化归因于文案。

本轮复核发现,GitHub About 原先保留早期的关键词堆叠描述,主页指向 https://biezou.com,topics 只有 chinese、english-learning、tutorial。仓库还被标记为 template 且没有 Release。这些设置与当前的双语开放书稿、GitHub Pages 主站和持续出版流程不完全一致,会让第一次访问的人误判项目类型,也减少通过主题搜索找到项目的机会。

本轮已把首屏入口改成“可获得什么 → 五分钟开始 → 十四天复测 → 九十天复盘”,并新增自然的 Star、Issue 和实践反馈入口;新增 CITATION.cff,让书稿可以被 GitHub 的引用入口识别。仓库 About 也已同步更新:

  1. description 改为“中英双语终身学习指南:英语学习、AI 协作、真实项目与成长证据”,同时提供英文简介。
  2. homepage 改为 https://byoungd.github.io/up/,与当前发布站点一致。
  3. 新增 ai-literacy、lifelong-learning、self-directed-learning、open-education,并保留原有主题。

待作者确认的出版决策:template 标记是否继续保留;是否按书稿版本建立 GitHub Release,并附中英 EPUB/PDF、变更摘要和校验信息。CITATION.cff 随本地内容改动发布后,还应检查 GitHub 的引用入口是否正确显示;后续定期核对 About、主页、topics 和 README 首屏是否一致。

历史复核中的发现与当时处理

发现 读者或维护影响 本轮处理
创业经历和资源层工程较丰富,首次用户验证和交付经营步骤不够集中 读者理解原则后仍不知道第一次访谈、试点或核算怎样做 增加客户验证、可持续经营两篇实操及完整实验卡
自律与坚持已分布在生活系统、节律和长期行动里 再加同样长的理论章会重复主线 增加一篇卡点排查手册和两个完整案例,并链接原理论与账本
AI 学习与项目框架已有,但重复流程与版本比较缺少贯通练习 容易把一次演示成功当成稳定交付 增加工作流、可靠性评测和逐版本评测记录,记录人工修订与全部时间
新实践需要统一入口 页面加入导航后仍可能难以按问题找到 新增实践路线图,联通首页、顶栏、工具箱、旧章节与模板
出版函数使用固定导航下标 插入分组容易漏章节或把错误分组放入书稿 分组显式标记 publication,按开卷、正文、附录角色选择;增加重排回归
AI 来源时效依赖三个硬编码文件名 新 AI 章节可能绕过核验 按 AI 章节命名和显式 sources_checked 检查真实日期、未来日期和 120 天期限
图片与链接解析存在缺口 HTML 图片或图片外层链接失效不能及时发现 核验 src、srcset、引用式链接、编码路径及 public 资源;保持原 alt 质量规则
README 生成与检查重复维护转换规则 新入口可能在网页正常、GitHub README 失效 抽取共用路径转换模块并增加回归
扩充全文使中文搜索索引超出已有预算 下载体积增加,移动端搜索成本上升 实操页索引 H1/H2 标题,三张模板只索引 H1;保留原预算
图片与 TOML 依赖存在三项高危审计告警 CI 审计失败,旧解析依赖风险继续存在 Sharp 更新至 0.35.4,仅对 markdownlint-cli2 的 smol-toml 覆盖为 1.7.1;审计降至零
搜索测试可能在 SSR 按钮可见、Vue 尚未挂载时点击 首击未被监听,出现偶发测试失败 点击前等待应用挂载;用延迟页面脚本复现确认,不用固定睡眠掩盖问题
PDF 长中文标题和代码行超出版心 部分标题和可复制模板被裁切 中文各级标题启用 CJK 换行,代码按真实字体宽度折行;补足字体子集并加入七项排版回归
AI 工具接入和评测的实践持续变化 只保存提示词或只看最终回答,无法说明权限范围与真实完成状态 根据 OpenAI、MCP 与 Anthropic 一手资料补充模型/工具/指令边界、授权撤回、task/trial/transcript/outcome 分离和环境结果检查

内容结构

docs/
  practice.md                         按当前问题选择实践路线
  threads/practice/
    customer-discovery.md             访谈、反证、人工试点与首批用户
    sustainable-business.md           范围、全部工时、回款、容量与复购
    discipline-and-consistency.md     卡点排查、中断重启与退出
    ai-workflows.md                   输入、执行、核验、交付与失败出口
    ai-evaluation.md                  样本、版本、硬性条件与成本比较
  templates/
    startup-experiment.md             创业实验卡与完整填写案例
    consistency-plan.md               单次行动实验与重启计划
    ai-evaluation.md                   分版本、分尝试的评测记录
  en/                                 上述九页的完整英文对应
scripts/lib/
  content-checks.mjs                   可独立测试的校验逻辑
  readme.mjs                           共用 README 路径转换
tests/content/                        内容规则与出版完整性回归

共新增九组、十八个双语页面。实践手册收入电子书附录,旧文和技术词表仍保持在线查阅。所有既有正文 URL 保留。

内容边界与编辑取舍

  • 方法、时间预算、样本数量与经营数字明确标为练习设计或假设案例,不伪装成研究结论、作者经历、真实客户或收入证明。
  • 创业内容要求同时保留反对假设的证据,区分付费意向、到账、交付义务和返工成本。
  • 自律内容结合现实容量和停止条件,避免用连续打卡或工作时间评价人格;新手册引用既有理论而不重复扩写。
  • AI 章节引用已阅读的 Anthropic 官方工程文章,只借用工作流/智能体、任务/尝试/结果等概念;不用文中工具名称推导当前选型,不宣称任何模型胜出。
  • 不更新未重新核验的旧 sources_checked。旧章新增入口只更新稿件 updated 日期。
  • 英文保留中文案例的数字、限制、结构与决策,独立检查示例算式与跨章一致性。

同步与本地改动保护

远端更新先合并到 codex/learning-practice-expansion。本地原有提交保留;原未提交变更在合并前建立 stash 备份,再逐项恢复并处理冲突。

外链流程保留远端专用探针、退役地址守卫和失败 issue 机制,并接入本地 HTTP/HTTPS 地址提取方案。词汇 DOI 修正已被远端更完整的来源修订接替,因此保留远端正文,避免重新引入已退役地址。原始修改仍可在具名 stash 中追溯。

普通全历史下载遇到网络中断后,使用 Git 部分克隆方式取得最新提交与所需文件;origin 配置为按需获取历史 blob,当前工作区完整,后续读取缺失历史内容时需要网络。

本轮结果保存在本地分支与工作区,未推送或触发线上部署。

出版文件清单(截至 2026-10-19)

下表数据来自当前跟踪的 epub-manifest.json 与 pdf-manifest.json,不是 2026-10-07 的验收结果。四个文件都覆盖 81 个出版章节;范围为主书稿、词汇表与工具箱,归档和词表仍仅在线提供。字节数、页数和 SHA-256 已与本地出版文件交叉核对。

版本 语言 章节 页数 字节 SHA-256
EPUB 3.3 中文 81 — 2,781,072 e8446b2244ba029ab36418b12b758938253d4f7aa0e06a8c7208591ffa8b5c48
EPUB 3.3 English 81 — 2,748,707 882a1f99f3bd46c3bed6276d7d10c013933922d0340b1f484189313d049be3a7
PDF 1.7 中文 81 434 5,111,215 2451f4c2e85f1d4852e36911aab53e7a6ed8be2d470324b451e6f1d1befeb251
PDF 1.7 English 81 493 4,228,820 4401a8d3370c2ca2b2e009b360e514ab6be48a5b0bd857efb545003791b93c9d

PDF 页面尺寸为 6 × 9.6 英寸,manifest 标注的检查器为 pypdf 6.16.2。以后更新出版统计时,以本次构建生成的 manifest 为准,不沿用下方的历史验收数字。

历史验证记录与后续维护

验证命令与发布顺序见 维护指南。以下是截至 2026-10-07 的历史验收记录;其中命令通过情况只说明当时运行结果,出版章节和 PDF 页数已由上方 manifest 快照更新。

最终验收结果:

  • npm run check 通过:32 项内容与出版回归、194 个 Markdown 文件、双语一致性、导航、README 镜像、格式及电子书同步检查。
  • python3 tests/pdf_layout_test.py 在锁定 PDF 依赖的环境中通过 7 项排版回归;修复后重新渲染并检查 12 个中英文代表页,长标题和代码未再越出版心。
  • npm run test:smoke 在重新构建并启动的站点上通过全部 520 项桌面/移动端测试,覆盖新页面、搜索、导航和下载文件;构建体积检查同时通过。
  • npm audit --audit-level=high 报告 0 项漏洞;git diff --check 无错误。
  • 当时验收记录为两个语言版本各 71 个出版章节、中文 PDF 371 页、英文 PDF 423 页;这些数字已过期,不代表当前出版物。当前值见上方截至 2026-10-19 的 manifest 清单。

检查过程中确认:VitePress 预览服务会缓存启动时的资源列表和响应长度。反复构建后沿用旧进程会产生脚本 404 或下载长度错误,导致一次验证环境失败;重启后全量通过。维护指南已补充这一操作要求。

维护时优先观察真实读者是否能从路线图完成一个实验,以及哪些模板字段实际帮助了决定。新增主题先寻找既有章节入口,只在有不同任务、案例或验收方法时增加页面。搜索发现依赖标题,因此实操标题应包含读者会使用的词;新增章节后继续运行体积预算和搜索回归。

外链的可访问状态、产品功能和长期行为效果不能由本地构建证明;本文未对旧资料做全量重新研究,也未宣称练习方案已获得用户效果验证。慢网络下 SSR 交互早于挂载的窗口仍是上游主题行为,当前测试等待仅让自动化按实际就绪状态操作。