Back to Details

indexion-plan-readme

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

indexion plan readme

indexion plan readme

Generate README documentation writing plans based on templates and source analysis.
基于模板和源码分析生成README文档编写计划。

When to Use

适用场景

  • User wants to create README files for each package
  • User asks to plan documentation writing tasks
  • User wants to generate doc tasks for manual or LLM authoring
  • Before a documentation sprint, to identify what READMEs need writing
  • 用户需要为每个软件包创建README文件
  • 用户要求规划文档编写任务
  • 用户需要生成供人工或LLM编写使用的文档任务
  • 文档冲刺启动前，明确需要编写的README内容

Usage

使用方法

bash
undefined
bash
undefined

Generate README writing plan using a template

Generate README writing plan using a template

indexion plan readme --template=.indexion/state/templates/readme.md <path>
indexion plan readme --template=.indexion/state/templates/readme.md <path>

Output plans to a directory

Output plans to a directory

indexion plan readme --template=readme.md --plans-dir=.indexion/plans <path>
indexion plan readme --template=readme.md --plans-dir=.indexion/plans <path>

JSON output

JSON output

indexion plan readme --template=readme.md --format=json <path>
indexion plan readme --template=readme.md --format=json <path>

Custom KGF specs directory

Custom KGF specs directory

indexion plan readme --template=readme.md --specs-dir=kgfs <path>
indexion plan readme --template=readme.md --specs-dir=kgfs <path>

Output to file

Output to file

indexion plan readme --template=readme.md -o=readme-plan.md <path>
undefined
indexion plan readme --template=readme.md -o=readme-plan.md <path>
undefined

Options

可选参数

OptionDefaultDescription
--template=FILE
(required)Template file for README generation
--plans-dir=DIR
.indexion/plansOutput directory for plans
--format=FORMAT
markdownOutput format: markdown, json
--specs-dir=DIR
kgfsKGF specs directory
--output=FILE, -o=
stdoutOutput file path
选项默认值描述
--template=FILE
(必填)用于生成README的模板文件
--plans-dir=DIR
.indexion/plans计划输出目录
--format=FORMAT
markdown输出格式：markdown、json
--specs-dir=DIR
kgfsKGF规范目录
--output=FILE, -o=
标准输出输出文件路径

Workflow

工作流程

  1. Run 
    indexion doc init .
    to create a README template
  2. Run 
    indexion plan readme --template=.indexion/state/templates/readme.md .
    to generate writing tasks
  3. Use the generated plans to write READMEs (manually or with LLM)
  1. 运行 
    indexion doc init .
    命令创建README模板
  2. 运行 
    indexion plan readme --template=.indexion/state/templates/readme.md .
    命令生成编写任务
  3. 使用生成的计划编写README（可手动编写或借助LLM完成）