内容整理流程

September 19, 2026 · View on GitHub

简体中文 | English

1. 先判断是否满足收录条件

当前主线为 X 上的 TypeSafe Jev 应用。正式条目需要:

  • 一条明确展示该应用的主帖,取数时点赞 ≥ 200
  • 原作者、原帖 URL、发布时间和点赞取数时间。
  • 具体用途、作者公开的实现说明或明确标为未知的实现细节。
  • 对应视频或图片,README 内有预览和可点击来源。

只谈设想、同名产品、纯新闻转载以及缺媒体的线索先放 inbox/README.md。不累计多个帖子的点赞来跨门槛。补充帖可以低于 200 赞,但不作为正式案例的门槛证据。

2. 去重与分类

先按原帖 ID、作者、项目名、仓库地址查重。同项目的新演示、更新和转载归入已有条目的 supplementary_posts;不同作者对同一游戏或同一问题的独立实现可以保留,但相邻排列并对比。

给每条选择一个主分组;多用途项目不在多个表重复计数。当前 11 类见 分类约定。只有一个项目的类别明确写“尚无同类对照”。

3. 写成通俗的双语介绍

每条先说明“能帮你做什么”,再用具体例子解释 Jev 和周围程序各自负责哪一步。必要术语第一次出现时解释;类比用于帮助理解,不把原帖未披露的机制写成事实。

中英文都填写 summary(用途)与 plain_explanation(通俗原理),再用 mechanism 保留技术细节。中文编辑内容和共享证据放在 data/catalog.json;英文编辑内容放在 data/catalog.en.json,按案例 slug 和分组 ID 对应。作者、点赞、日期、媒体只保留一份共享数据。

新增或修改案例和专题时同步两种语言。生成器会拒绝缺失英文条目或字段;这个检查保证结构完整,不自动保证翻译语义准确。

4. 维护正式目录

data/catalog.json 是案例及专题分析的编辑来源,scripts/build_catalog.py 同时生成中英文 README、案例详情、案例索引和各类对比。不要只修改生成后的 Markdown,否则下一次生成会覆盖它。

首页采用科普导览:六个精选展开,全部案例按用途折叠。data/homepage.json 保存精选案例的 slug、双语短解说与分类导语,不复制来源或日期。精选按用途和机制证据选择,不能只按点赞排序。普通卡片直接使用目录摘要;详细原理、精确快照与 A/B/C 评估继续在详情页保留。首页证据标签使用通俗名称,日期只显示“内容更新”的北京时间日期。改版排版不刷新历史时间;如改变案例事实或判断,应先同步目录内容及其更新时间。

以现有条目为样本增加 cases 记录,并根据 案例模板 补齐:摘要、通俗原理、输入输出机制、相对优势、限制、作者报告结果、主帖快照、媒体及公开项目入口。groups 保存类别选择建议、共同流程、分析与建议实验。

  • post.likes 只填写实际读取的数值;retrieved_at 填真实取数时间并带时区。
  • 每条必填 readme_added_atreadme_updated_at,使用含时区的 ISO 8601 时间。首次加入 README 时两者相同;此后修改该条简介、原理、证据或任一语言文字时,只更新 readme_updated_at,保留首次收录时间。统一展示为北京时间。
  • 仅排版、重新生成或补齐时间字段不刷新内容更新时间;不以原帖时间、取数时间或全库最近更新代替条目时间。历史时间依据
  • post.media_source 必须是图片/视频所属帖子,引用帖的媒体要指向被引用来源,并写清时间和用途。
  • 不把完整推文、凭据或私人账号数据写入目录。
  • 区分作者陈述和本库分析。未公开的机制不推断成事实;未运行保持“未复现”。

运行:

python3 scripts/build_catalog.py
python3 scripts/build_catalog.py --check
git diff --check

脚本不联网,校验门槛、唯一主帖、媒体、时区、英文翻译完整性及生成内容是否同步。它不会证明外部链接可访问或作者主张属实;新增内容还需人工核对原帖、媒体、相对链接和同类对比。

跨日期更新:案例目录取 readme_added_at 的北京时间日期。collected_on 保留首批收录及专题路径日期,避免旧链接失效;在 updates 追加实际来源复查事件,并同步 latest_update 为末项。只有该事件涉及的案例才更新来源复查日期;仅改翻译只改内容时间,不伪造复查。日期与路径回归检查:python3 -m unittest discover -s scripts -p 'test_*.py'

测试结果来自文档而非主帖时,填写共享字段 reported_result_source URL,让证据表直接指向对应文档。

主张证据审核:共享 claim_review 保存 tier(A/B/C)、实际 reviewed_at 和中文报告路径;review_summary 分别在中英文目录填写。双语报告必须提供对应案例 slug 锚点。A 是限定功能/原理的证据较清楚,B 是效果待验证,C 是具体宣传超出证据,不判项目造假。缺少审核的项目显示“尚未审核”。修改判断或理由更新内容时间,保留首次收录时间;证据审核时间用实际复查时间,不用生成时间代替。

项目简介的时间只显示 内容更新,不再并列首次收录或逐项审核时间。readme_added_at、来源快照与审核时间仍在数据及证据记录中保留;纯展示调整不刷新内容更新时间。

5. 拆解与复现

共同机制写在专题分析,独立深度研究参照 拆解模板 新建笔记。为新笔记补充索引时,应同时调整生成器的中英文拆解索引入口,避免再次生成时丢失。

首次实际复现前,扩展目录与生成器的复现记录字段,或为案例新增独立实验笔记并在条目链接中指向它;不能仅改 verification 而留下模板化的“未执行”正文。记录版本、环境、输入、成功标准、完整成本、耗时与错误,再更新状态。

官方文档、作者自测、观看演示、独立复现实验是不同证据等级。成本比较应包含前处理、回退、重试及执行器,不把单步延迟与完整任务时间混为一谈。

6. 媒体与后续维护

媒体优先外链原帖与 CDN 地址;权利归原作者。如需提交有使用依据的小型图片,按 附件约定SOURCES.md。不提交大型视频或私密原始资料。

点赞下降、帖子删除或应用失效时保留原始收录快照,追加实际复查说明;不要伪造新的取数时间。私人研究材料放在 Git 忽略的 local/,提交前检查暂存区。