linux.do

kiro 积分即将过期，用不完的佬看过来

从这kiro是要用不完了，是1月1日前就要用完这2000吗？继续讨论：

有些佬之前领的或者送的积分可能快过期了，可以考虑让 kiro 梳理旧项目的文档

我昨天对一个小项目进行了梳理，大约用掉了200+积分

反正过期也还是浪费，不如用来干点活:tieba_028:

下面贴一个我梳理文档用的 Steering 给各位佬参考，大家用的话可以根据自己的环境修改使用。

----------------------

inclusion: manual

----------------------

文档生成工作流

当用户请求"更新文档"、“生成文档”、"写文档"时，必须严格遵循此工作流。

核心原则

1. 代码优先 - 所有文档必须基于实际代码分析，禁止臆造
2. 模块内置 - 文档放在对应模块目录内，紧贴代码
3. 分步执行 - 每个模块独立处理，避免上下文溢出
4. 树状组织 - 每个模块有 README.md，内容过长则拆分子文档

文档结构规范


module/

├── README.md # 模块主文档（必需）

├── docs/ # 子文档目录（可选，当主文档过长时）

│ ├── component-a.md

│ └── component-b.md

└── submodule/

└── README.md # 子模块文档

README.md 模板


# 模块名称

> 一句话描述模块职责

## 概述

2-3 段描述模块的核心功能和设计思路。

## 核心组件

- `component_a.py` - 组件A的职责

- `component_b.py` - 组件B的职责

## 使用示例

（代码示例，基于实际代码）

## 子模块

- [submodule_name](./submodule/) - 子模块描述

## 相关文档

- [详细文档](./docs/detail.md)（如有拆分）

拆分规则

● 单文件超过 200 行 考虑拆分
● 拆分后主文档保留概述和链接
● 子文档放入 docs/ 目录

----------------------

工作流步骤

Step 1: 解析目标范围

用户输入格式：更新 <目标> 文档

目标解析规则：

● 项目 或 全部 → 整个项目所有模块
● 模块名 → 指定模块（如 scripts、tests）
● 模块/子模块 → 指定子模块（如 scripts/generator）

执行动作：

1. 确认目标范围，列出将要处理的模块清单
2. 询问用户确认后再继续

Step 2: 深度索引（每次必做）

执行动作：


0. Get-Location 获取项目目录

1. mcp_mcp_router_set_project_path - 设置项目路径，**必须使用项目绝对路径**

2. mcp_mcp_router_build_deep_index - 构建深度索引

3. mcp_mcp_router_find_files - 获取目标模块文件列表

输出：模块文件清单和结构概览

Step 3: 生成任务清单

基于模块结构，生成任务清单。每个模块/子模块 = 一个独立任务。

任务清单格式：


## 文档生成任务

- [ ] Task 1: 分析并生成 `scripts/generator/` 文档

- [ ] Task 2: 分析并生成 `scripts/validator/` 文档

- [ ] Task 3: 分析并生成 `scripts/` 主文档（汇总子模块）

- [ ] Task 4: 更新项目根 README.md（如需要）

执行顺序：叶子模块 → 父模块 → 根文档（自底向上）

执行动作：

1. 展示任务清单给用户
2. 询问用户确认或调整
3. 确认后开始逐个执行

Step 4: 执行单个任务

对每个任务，执行以下子步骤：

4.1 模块分析


1. mcp_mcp_router_get_file_summary - 获取每个文件的结构摘要

2. mcp_mcp_router_search_code_advanced - 搜索关键模式：

- 入口点（main, __main__, if __name__)

- 公开 API（def/class 不以 _ 开头）

- 重要常量和配置

3. 读取核心文件，理解实现逻辑

4.2 生成文档结构

基于分析结果，规划文档结构：

● 确定是否需要拆分
● 确定子文档划分
● 确定与其他模块的关联

4.3 编写文档

按照模板编写文档，确保：

● 所有描述基于代码分析
● 代码示例来自实际代码
● 链接指向真实文件

4.4 验证

● 检查所有文件路径引用是否存在
● 检查代码示例是否准确

Step 5: 任务完成确认

每个任务完成后：

1. 展示生成的文档内容
2. 标记任务完成
3. 询问是否继续下一个任务

重要：每个任务结束后暂停，等待用户确认再继续下一个任务。这样可以：

● 避免上下文累积
● 允许用户审阅和调整
● 支持断点续做

----------------------

禁止事项

● ❌️ 不经过代码分析就编写文档内容
● ❌️ 一次性处理所有模块（必须分任务）
● ❌️ 跳过用户确认直接执行
● ❌️ 编造不存在的函数、类或文件
● ❌️ 使用无效的内部链接
● ❌️ 使用相对路径（比如 .）作为项目路径

示例对话

用户：更新 scripts 文档

Kiro：

1. 我将为 scripts/ 模块生成文档。让我先进行深度索引…
2. [执行索引]
3. 发现以下子模块需要处理：

● scripts/generator/
● scripts/validator/
● scripts/librarian/
● scripts/llm/
● scripts/ (主模块)

1. 生成的任务清单：

● Task 1: scripts/generator/ 文档
● Task 2: scripts/validator/ 文档
● …

1. 确认开始执行吗？

用户：确认

Kiro：开始执行 Task 1…

22 views05:02