README
开源项目中常见的说明文档文件，用于介绍项目用途、安装步骤、使用示例和许可证等信息
时间轴 (近 90 天)
对于几个一次性脚本和notebook的小项目，一段README比文档站更适合；对于不打算做人工审核的项目，AI生成的文档会消耗用户信任，不如不写。
Python项目文档可分为四层：Docstring、API参考、指南与README、设计决策（为什么），AI擅长第一层和第三层，静态站点工具负责第二层，第四层需人工完成。
README是项目根目录下的说明文件，通常包含项目简介、安装步骤、环境变量清单、运行命令和已知限制。
缓解部落知识风险的办法是将其外化为架构决策记录（ADR）、README 注释或智能体指令文件。
claude.md 与通用的 README 不同，其服务对象是模型而非人类读者，更强调可执行性与约束性。
改进文档的核心是补全上下文，给出具体命令、版本检查方式和常见陷阱提示，而非单纯增加篇幅
付费测试中几乎所有测试者都在相同的地方卡住，尤其是环境搭建环节
应把隐性假设显式化，在文档中明确写出所有前置依赖、版本要求、环境变量和执行目录
在干净的虚拟机或容器中严格按README逐字执行可以模拟新用户环境的大部分问题
遇到项目撞车时，应在README顶部诚实说明差异化定位，如使用的语言和专注的特性
全部知识事实 (10)
对于几个一次性脚本和notebook的小项目，一段README比文档站更适合；对于不打算做人工审核的项目，AI生成的文档会消耗用户信任，不如不写。
50%待验证Python项目文档可分为四层：Docstring、API参考、指南与README、设计决策（为什么），AI擅长第一层和第三层，静态站点工具负责第二层，第四层需人工完成。
50%待验证README是项目根目录下的说明文件，通常包含项目简介、安装步骤、环境变量清单、运行命令和已知限制。
50%待验证缓解部落知识风险的办法是将其外化为架构决策记录（ADR）、README 注释或智能体指令文件。
50%待验证claude.md 与通用的 README 不同，其服务对象是模型而非人类读者，更强调可执行性与约束性。
50%待验证改进文档的核心是补全上下文，给出具体命令、版本检查方式和常见陷阱提示，而非单纯增加篇幅
50%待验证付费测试中几乎所有测试者都在相同的地方卡住，尤其是环境搭建环节
50%待验证应把隐性假设显式化，在文档中明确写出所有前置依赖、版本要求、环境变量和执行目录
50%待验证在干净的虚拟机或容器中严格按README逐字执行可以模拟新用户环境的大部分问题
50%待验证遇到项目撞车时，应在README顶部诚实说明差异化定位，如使用的语言和专注的特性
50%