Skip to content

Commit 78c395d

Browse files
committed
【修复】更新文档优化步骤和说明
- 修改报告模板验证步骤,使用 parts 文件夹中的 HTML 文件进行检查 - 更新 PlantUML 渲染和截图转换的说明,直接使用报告.html 文件 - 同步更新英文和中文版本的 README 文件
1 parent d798c8b commit 78c395d

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.EN.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ To optimize the report template's style and format:
107107

108108
2. Create new Roo Code session in `Code` mode, paste modified prompt and send;
109109
3. Wait for first task completion;
110-
4. Verify `report_template.html` in browser;
110+
4. Verify `parts/【Section Number】.html` in browser;
111111
5. If unsatisfied, request modifications;
112112
6. If satisfied, send next task: ``Good. Now: **Complete the `【Section Number】Section Title` section.**`` (replace with actual section);
113113
7. Wait for completion;
@@ -124,7 +124,7 @@ These steps require manual operation (currently difficult to automate):
124124
2. Manually insert contents from `parts` folder into corresponding positions in `report.html`;
125125
3. Create new Roo Code session in `Ask` mode, request agent review of `report.html` for redundancies/errors;
126126
4. Manually edit redundancies; for logical errors, follow steps 6-9 in [Document Writing](#document-writing) to revise;
127-
5. Find all `@startuml` in `report_template.html`, render each via [PlantUML Web Server](https://www.plantuml.com/plantuml/uml), convert images to [data URLs](https://www.lmstfy.icu/Bing/?q=aW1hZ2UgdG8gZGF0YSB1cmwgb25saW5l) and replace:
127+
5. Find all `@startuml` in `report.html`, render each via [PlantUML Web Server](https://www.plantuml.com/plantuml/uml), convert images to [data URLs](https://www.lmstfy.icu/Bing/?q=aW1hZ2UgdG8gZGF0YSB1cmwgb25saW5l) and replace:
128128

129129
```diff
130130
- <div class="code-block">
@@ -137,7 +137,7 @@ These steps require manual operation (currently difficult to automate):
137137
</div>
138138
```
139139

140-
6. Find all `` in `report_template.html`, convert required screenshots to [data URLs](https://www.lmstfy.icu/Bing/?q=aW1hZ2UgdG8gZGF0YSB1cmwgb25saW5l) and replace:
140+
6. Find all `` in `report.html`, convert required screenshots to [data URLs](https://www.lmstfy.icu/Bing/?q=aW1hZ2UgdG8gZGF0YSB1cmwgb25saW5l) and replace:
141141

142142
```diff
143143
<div class="diagram">

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109

110110
2. 在 Roo Code 新建会话,设定模式为 `Code`,粘贴上一步修改的提示词并发送;
111111
3. 等待智能体完成第一轮任务;
112-
4. 用浏览器打开检查`报告模板.html`,查看是否满足要求;
112+
4. 用浏览器打开检查 `parts/【标题编号】.html`,查看是否满足要求;
113113
5. 如果不满足要求,请求智能体修改直至要求满足;
114114
6. 如果满足要求,向智能体发送第二轮任务:``很好。现在:**完成`【标题编号】标题`部分。**``(把`【标题编号】标题`替换为欲编写的标题编号和标题);
115115
7. 等待智能体完成第二轮任务;
@@ -126,7 +126,7 @@
126126
2. 手动将 `parts` 文件夹下的所有文件的内容手动插入至`报告.html`中的对应位置;
127127
3. 在 Roo Code 新建会话,设定模式为 `Ask`,要求智能体阅读`报告.html`,检查是否存在重复、冗余或不合理的地方,由用户手动修改;
128128
4. 如果存在重复、冗余的地方,手动删改;如果存在不合理的地方,在要求智能体避开不合理问题的前提下参考[文档撰写](#文档撰写)的步骤 6 至 9,修改该不合理章节;
129-
5. 查找`报告模板.html`内所有的 `@startuml`,依次将所有 UML 代码逐个粘贴至 [PlantUML Web Server](https://www.plantuml.com/plantuml/uml) 渲染,将渲染后的[图片转为 data url](https://www.lmstfy.icu/Bing/?q=5Zyo57q/5Zu+54mH6L2sIGRhdGEgdXJs) 格式替换掉原 UML 代码块:
129+
5. 查找`报告.html`内所有的 `@startuml`,依次将所有 UML 代码逐个粘贴至 [PlantUML Web Server](https://www.plantuml.com/plantuml/uml) 渲染,将渲染后的[图片转为 data url](https://www.lmstfy.icu/Bing/?q=5Zyo57q/5Zu+54mH6L2sIGRhdGEgdXJs) 格式替换掉原 UML 代码块:
130130

131131
```diff
132132
- <div class="code-block">
@@ -139,7 +139,7 @@
139139
</div>
140140
```
141141

142-
6. 查找`报告模板.html`内所有的 ``,依次将所有的需手动添加的[图片或截图转为 data url](https://www.lmstfy.icu/Bing/?q=5Zyo57q/5Zu+54mH6L2sIGRhdGEgdXJs) 格式后替换掉原 diagram 类下元素:
142+
6. 查找`报告.html`内所有的 ``,依次将所有的需手动添加的[图片或截图转为 data url](https://www.lmstfy.icu/Bing/?q=5Zyo57q/5Zu+54mH6L2sIGRhdGEgdXJs) 格式后替换掉原 diagram 类下元素:
143143

144144
```diff
145145
<div class="diagram">

0 commit comments

Comments
 (0)