Skip to content

docs: 添加3个通用场景usecase文档 - #4

Merged
yi-ge merged 5 commits into
desirecore:mainfrom
mashagua:add-usecase-docs
Apr 21, 2026
Merged

docs: 添加3个通用场景usecase文档#4
yi-ge merged 5 commits into
desirecore:mainfrom
mashagua:add-usecase-docs

Conversation

@mashagua

Copy link
Copy Markdown
Contributor

概述

添加 3 个通用场景的 use case 文档

新增内容

  • 📊 数据分析智能体 use case (06-data-analysis-agent.md)
  • 🖼️ 流程图生成智能体 use case (07-flowchart-agent.md)
  • 🌐 网页抓取智能体 use case (08-web-scraping-agent.md)

资源文件

  • assets/data-analysis/ — 数据分析相关样例文件
  • assets/flowchart/ — 流程图相关资源
  • assets/web-scraping/ — 网页抓取相关资源
  • assets/ 截图已改为描述性命名

已处理的 review 意见

  • ✅ 删除了所有开发脚本(generate_*.py/js)
  • ✅ 删除了 ocr/ 文件夹及微信图片
  • ✅ 截图改为描述性命名
  • ✅ 中文路径改为英文路径(数据分析→data-analysis,流程图→flowchart)
  • ✅ 清理了孤立文件(.DS_Store、重复的 xlsx 等)

- 数据分析智能体 use case
- 流程图生成智能体 use case
- 网页抓取智能体 use case
- 包含相关assets资源文件
- 重命名文件去掉 -agent 后缀,与现有文档风格一致
- 明确 06-data-analysis-report 与 02-data-analysis 的区别
- 删除开发脚本(generate_*.py/js)
- 清理未引用的孤立文件和重复文件
- 截图文件改为描述性命名
- 中文路径改为英文路径(数据分析→data-analysis, 流程图→flowchart)
- 恢复 -agent 后缀命名(reviewer 确认合理)
- 移除与 02-data-analysis.md 的区别说明(reviewer 撤回重叠问题)
- 删除未引用的孤立文件(ocr/、ecommerce-return-flow.drawio、微信图片)
- 保留之前的修改:删除开发脚本、截图描述性命名、中文路径改英文
@vercel

vercel Bot commented Apr 19, 2026

Copy link
Copy Markdown

@mashagua is attempting to deploy a commit to the yige's Team Team on Vercel.

A member of the Team first needs to authorize it.

@mashagua

Copy link
Copy Markdown
Contributor Author

基于 PR #3 review 意见的修改确认

✅ 已完成的修改

# Review 意见 处理结果
1 文件命名 -agent 后缀 根据您后续更新意见,保留 -agent 后缀
2 与 02-data-analysis.md 重叠 根据您后续更新意见,两者定位不同,已保留
3 删除开发脚本 ✅ 已删除 5 个 generate_*.py/js
4 清理孤立文件 ✅ 已删除 ocr/、微信图片、ecommerce-return-flow.drawio、重复 xlsx
5 截图描述性命名 ✅ 已改为描述性命名
6 中文路径改英文 ✅ 数据分析→data-analysis、流程图→flowchart
7 二进制大文件 ⏭️ 暂未处理

最终 assets 目录结构

assets/
├── data-analysis/
│   ├── case1/消费行业销售数据分析报告.docx
│   └── finance_q1_report/
│       ├── 2024Q1_财务分析报告.docx
│       ├── 2024Q1_财务分析报告.pdf
│       └── 2024Q1_财务数据.xlsx
├── flowchart/microservice-architecture.drawio
├── gucci-products-scraping.png
├── microservice-architecture.png
├── sales-data-analysis-report.jpeg
└── web-scraping/gucci_handbags.xlsx

麻烦帮忙审核,谢谢!

@yi-ge yi-ge left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

所有 review 反馈已确认修复:

  • ✅ 开发脚本已移除(generate_*.py/js,共 5 个)
  • ✅ 中文路径已改为英文(数据分析→data-analysis,流程图→flowchart)
  • ✅ 截图已改为描述性命名
  • ✅ 孤立文件已清理(ocr/ 目录、微信图片、重复 xlsx 等)
  • ✅ 文件总数从 22 个精简到 12 个

三篇文档结构清晰,场景示例具体,效率对比有说服力。可以合并。

@yi-ge

yi-ge commented Apr 19, 2026

Copy link
Copy Markdown
Member

Review 补充:缺少英文翻译

检查 i18n/en/docusaurus-plugin-content-docs/current/03-use-cases/01-general/ 后发现:

中文文档 英文翻译 状态
01-document-writing.md 01-document-writing.md
02-data-analysis.md 02-data-analysis.md
03-email-management.md 03-email-management.md
04-meeting-assistant.md 04-meeting-assistant.md
05-translation.md 05-translation.md
06-data-analysis-agent.md 不存在
07-flowchart-agent.md 不存在
08-web-scraping-agent.md 不存在

新增 3 篇 use case 文档需要补充英文版本,路径:

i18n/en/docusaurus-plugin-content-docs/current/03-use-cases/01-general/
├── 06-data-analysis-agent.md
├── 07-flowchart-agent.md
└── 08-web-scraping-agent.md

请补充翻译后我再检查。

yi-ge and others added 2 commits April 20, 2026 21:39
…new use-case docs

- Add frontmatter (title, description, keywords) to 06/07/08 use-case docs
- Add English translations in i18n/en/ for bilingual documentation compliance

Refs: desirecore#4
Updated text to ensure consistency in data definitions within the pain points section.

@mashagua mashagua left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修正了一个英文中夹杂中文单词的句子

@yi-ge
yi-ge merged commit e0de368 into desirecore:main Apr 21, 2026
1 check failed
yi-ge added a commit that referenced this pull request Jul 28, 2026
- Add team-only directory exception to EN plan-confirmation.md (P2 #3)
- Align clarification and Plan ordering in delegation-model.md (P2 #4)
- Both CN and EN versions updated
yi-ge added a commit that referenced this pull request Jul 28, 2026
* docs: explain file-backed Plan workflow

* docs: clarify team workspace indicators

* docs: explain team-only workspace mode

* docs: remove blanket plan approval semantics

* fix: address PR #33 review comments

- Add team-only directory exception to EN plan-confirmation.md (P2 #3)
- Align clarification and Plan ordering in delegation-model.md (P2 #4)
- Both CN and EN versions updated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants