用途:为软件包生成 README 文档写作计划。它依据模板并结合源码分析,产出可执行的写作任务,供人工或 LLM 编写文档时使用。适用时机包括:为每个包创建 README、规划文档写作任务、为后续编写生成文档任务,以及在文档冲刺前明确需要撰写哪些 README。
主要用法(命令保持原样): indexion plan readme --template=.indexion/state/templates/readme.md <path> indexion plan readme --template=readme.md --plans-dir=.indexion/plans <path> indexion plan readme --template=readme.md --format=json indexion plan readme --template=readme.md --specs-dir=kgfs indexion plan readme --template=readme.md -o=readme-plan.md
选项:--template=FILE(必填,README 生成模板文件);--plans-dir=DIR(计划输出目录,默认 .indexion/plans);--format=FORMAT(输出格式:markdown、json,默认 markdown);--specs-dir=DIR(KGF specs 目录,默认 kgfs);--output=FILE/-o(输出文件路径,默认 stdout)。
工作流:1) 运行 indexion doc init . 创建 README 模板;2) 运行 indexion plan readme --template=.indexion/state/templates/readme.md . 生成写作任务;3) 使用生成的计划编写 README(手动或借助 LLM)。
限制:资料未说明收费、价格、平台支持范围、效果保证或额外使用步骤,暂未提供;模板为必填项,缺少模板无法生成计划。