用途:构建项目 README,覆盖脚手架、生成、规划、组装与校验。评估已有文档属于另一技能 indexion-documentation。
主要能力:doc init 创建 .indexion/readme/template.md 与 doc.json(仅绿地项目);doc readme --per-package 从 /// 文档注释生成各包 README 骨架(仅 API 层,不覆盖已有文件);doc readme --config=doc.json 按配置组装根 README,根段类型有 static(原样引入 md 文件)、toc(目录标题)、packages(按 glob 拉取包条目);doc readme --template 支持 {{include:path}}、{{packages}}、{{module_doc}} 占位符;plan readme 生成分节写作任务;plan drift 比较前后版本,判断改动是否为纯新增,CLI 可用 --vocab-threshold 做 CI 守卫。
使用方式:先检查 git diff、README.md 符号链接、doc.json 与 .indexion.toml 判断 README 属于手工维护、构建组装还是混合。绿地执行 indexion doc init <project-dir>,编辑 doc.json 与 docs/*.md,运行 doc readme --per-package 后手写 Overview、Usage、Options、Examples,再 doc readme --config 组装,最后以 plan drift 校验。.indexion.toml 的 [doc] config_path 可自动加载配置,per_package = true 使路径参数默认按包处理;显式 --config 优先。
限制:packages 根段当前只输出包链接表格,不内联展开 packages 条目的 sections,因此丰富的命令级说明需手工维护;模板模式遍历路径时会自动为缺失 README 的包创建文件,可能产生非预期新增;--per-package 只创建不覆盖,需先删除旧文件才能重生成;plan drift 的 cosine 阈值仅为建议用法示例。具体价格、平台与更多细节暂未提供。