用途:为文件夹编写 README.md,帮助开发者理解该目录为何存在、内部内容如何组织,以及新代码应放在哪里。它面向的是项目内部文档,不适用于根项目 README 的安装、使用说明等场景。
主要能力与写作要点:说明目的与组织逻辑;提供非显而易见的上下文;在相关时说明与其他文件夹的关系;保持可快速浏览,通常几句话到一小段即可。
正确做法示例:标题下写明该目录做什么,例如“Converters”用于把字段模式转换为面向具体格式的表示,并解释字段模式是带 x-component 提示的纯 JSON Schema,不同系统需要不同格式(如运行时校验用 ArkType、SQLite 列定义用 Drizzle),每个转换器输入相同、输出面向特定消费者,需要新格式时在此新增转换器。
应避免的做法:重复代码已可见的内容,例如逐条列出 to-arktype.ts、to-drizzle.ts、index.ts 并附一句说明。
限制:资料未提供安装命令、依赖或平台要求;该技能不覆盖根项目 README 的安装与使用等内容。