@aigne/doc-smith 0.9.8-alpha.5 → 0.9.8-alpha.6

package/doc-smith/references/changeset_schema.md

@@ -6,8 +6,6 @@ Changeset 只包含两类修改：
 1. **全局语义修改** - 跨文档的规则、术语、风格
 2. **结构重写** - 补充、重写、重组特定章节
 
-**注意：** PATCH 类修改通过文档内 `:::PATCH` 标记实现，不会出现在 changeset 中。
-
 ## 读取和理解
 
 Changeset 是自然语言文本，格式自由。你需要：
@@ -42,51 +40,17 @@ Changeset 是自然语言文本，格式自由。你需要：
 "API 文档补充错误码说明"         → 结构重写
 ```
 
-## 常见模式参考
-
-### 模式 1：简单列表
-```markdown
-1. 统一术语："API" → "API 接口"
-2. 补充 overview.md 的项目背景
-3. 删除所有形容词
-```
-
-理解：1, 3 是全局修改；2 是结构重写
-
-### 模式 2：分类组织
-```markdown
-## 全局修改
-- 代码示例添加语言标识符
-- 禁止使用第一人称
-
-## 补充内容
-- getting-started.md 添加环境要求
-- api/errors.md 补充错误原因
-```
-
-理解：按章节分类，直接识别
-
-### 模式 3：自由描述
-```markdown
-发现文档问题：
-- "API" 和 "接口" 混用，统一为 "API 接口"
-- 快速开始缺环境要求说明
-```
-
-理解：第一条是全局修改，第二条是结构重写
-
 ## 执行流程
 
 ### 1. 读取文件
-```bash
-cat <changeset-file-path>
-```
+
+读取 changeset 文件，只读取用户指令中指定的文件，忽略其他 changeset 文件。
 
 ### 2. 分类汇总
 
 **全局修改：**
-- 规则 1: ...
-- 规则 2: ...
+- 1: ...
+- 2: ...
 
 **结构重写：**
 - 文档 A, 章节 X: ...
@@ -97,9 +61,6 @@ cat <changeset-file-path>
 **优先级：** 全局修改 → 结构重写
 
 **全局修改：**
-```bash
-find .aigne/doc-smith/docs/ -name "*.md"
-```
 遍历所有文档，应用规则
 
 **结构重写：**

package/doc-smith/references/document_update_guide.md

@@ -43,18 +43,21 @@
 **处理方式：**
 1. 扫描所有文档查找 `:::PATCH` 标记
 2. 读取 PATCH 内的修改指令
-3. 执行精确替换
+3. 在指定位置完成 PATCH要求的修改，可能包含：替换原始内容、删除内容、新增内容
 4. 删除整个 PATCH 标记
 
 **PATCH 标记格式：**
 ```markdown
 ::: PATCH
-修改说明或新内容
+# Original
+DocSmith 直接修改用户文档并写回到原项目。
+
+# Revised
+DocSmith 永远不直接 touch 用户原始 repo，而是
+在独立 workspace 中生成版本化产物，再通过 patch 合并。
 :::
 ```
 
-**来源：** 仅通过文档内标记（不会出现在 Changeset 文件中）
-
 ## 三种输入方式处理
 
 ### 方式 1：自然语言修改请求
@@ -133,10 +136,6 @@ ls -la .aigne/doc-smith/docs/
 **执行优先级：** 全局修改 → 结构重写 → PATCH
 
 **全局修改：**
-```bash
-# 获取所有文档
-find .aigne/doc-smith/docs/ -name "*.md"
-```
 对每个文档：
 - 读取内容
 - 应用规则（替换、删除、添加）

package/doc-smith.yaml

@@ -1,97 +1,14 @@
 type: ai
 name: docsmith
-keep_text_in_tool_uses: true
 task_render_mode: collapse
+
 instructions:
   - role: system
     url: ./main-system-prompt.md
 
 input_key: message
 skills:
-  - type: function
-    name: askUserQuestion
-    description: |
-      Use this tool when you need to ask the user questions during execution. This allows you to:
-      1. Gather user preferences or requirements
-      2. Clarify ambiguous instructions
-      3. Get decisions on implementation choices as you work
-      4. Offer choices to the user about what direction to take.
-
-      Usage notes:
-      - The system automatically adds an "✏️ Other" option to all questions, allowing users to provide custom text input. DO NOT add your own "Other", "需要调整", or similar options - they will cause duplication.
-      - Only provide the specific action options (e.g., "✅ Confirm"). The "Other" option is handled by the system.
-      - Use multiSelect: true to allow multiple answers to be selected for a question
-      - If you recommend a specific option, make that the first option in the list and add "(Recommended)" at the end of the label
-    input_schema:
-      type: object
-      properties:
-        questions:
-          type: array
-          items:
-            type: object  
-            properties:
-              question:
-                type: string
-                description: The complete question to ask
-              header:
-                type: string
-                description: Short label(max 12 chars)
-              options:
-                type: array
-                items:
-                  type: string
-                description:
-                  Available choices (2 ~ 4 options)
-              # multiSelect:
-              #   type: boolean
-              #   description: Allow multiple selections
-            required:
-              - question
-              - header
-      required:
-        - questions
-    process: |
-      const {questions} = input
-
-      const answers = []
-      const OTHER_OPTION = '✏️ Other'
-
-      for (const item of questions) {
-        let answer
-
-        if (item?.options?.length) {
-          answer = await options.prompts.select({
-            message: item.question,
-            choices: [
-              ...item.options.map(option => ({
-                name: option,
-                description: option,
-                value: option
-              })),
-              {
-                name: OTHER_OPTION,
-                description: 'Enter your own response',
-                value: OTHER_OPTION
-              }
-            ]
-          })
-
-          if (answer === OTHER_OPTION) {
-            answer = await options.prompts.input({
-              message: 'Please enter your response:'
-            })
-          }
-        } else {
-          answer = await options.prompts.input({
-            message: item.question
-          })
-        }
-
-        answers.push({question: item.question, answer})
-      }
-
-      return {answers}
-
+  - type: "@aigne/agent-library/ask-user-question"
 
 afs:
   modules:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.9.8-alpha.5",
+  "version": "0.9.8-alpha.6",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"