Skip to content

Commit b5a66fe

Browse files
committed
docs:补充说明
1 parent 1dbba23 commit b5a66fe

File tree

2 files changed

+43
-3
lines changed

2 files changed

+43
-3
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,26 @@ AI Code Context Helper 是一款轻量级桌面应用,为所有需要理解、
88
<img src="./_images/app.gif" width="50%" alt="动图">
99
</p>
1010

11+
## 👥 适用人群
12+
13+
- **编程初学者**: 通过 AI 理解开源项目结构和代码逻辑,加速学习曲线
14+
- **软件开发人员**: 在现有工作流中无缝集成 AI 编程助手,提高开发效率
15+
- **代码审查者**: 快速提取项目模块代码,利用 AI 进行质量审查和优化建议
16+
- **技术教育者**: 更有效地解释代码结构和实现细节,辅助教学过程
17+
- **开源贡献者**: 快速熟悉新项目代码库,降低贡献门槛
18+
19+
## 🎯 主要应用场景
20+
21+
本工具让您可以轻松将代码内容传递给 AI 助手,实现以下场景:
22+
23+
- **代码学习**: 理解复杂项目结构和工作原理,提高学习效率
24+
- **开发辅助**: 获取更准确的代码修改和功能实现建议
25+
- **代码审查**: 进行自动化质量检查和性能优化分析
26+
- **重构指导**: 基于完整上下文的代码改进建议
27+
- **问题诊断**: 通过提供完整环境帮助 AI 更准确地定位问题
28+
29+
所有功能都在本地运行,不需要联网,确保您的代码隐私安全。
30+
1131
## 💡 核心使用场景
1232

1333
### 1. 代码学习与分析

README_en.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,37 @@
22

33
## 📝 Introduction
44

5-
AI Code Context Helper is a lightweight desktop application designed for anyone who needs to understand, learn, or develop code. Whether you're a programming beginner, professional developer, or educator, it helps you easily extract code context and communicate efficiently with AI assistants. Through visual project structure display and one-click code export, it makes understanding complex code, getting AI programming suggestions, and conducting code reviews unprecedentedly simple. This powerful yet simple tool accelerates the learning curve for beginners while improving productivity for professional developers, whether you're learning code, developing new features, or seeking code improvement suggestions.
5+
AI Code Context Helper is a lightweight desktop application designed for anyone who needs to understand, learn, or develop code. Whether you're a programming beginner, professional developer, or educator, it helps you easily extract code context and communicate efficiently with AI assistants. Through visual project structure displays and one-click code export, it makes understanding complex code, getting AI programming suggestions, and conducting code reviews unprecedentedly simple. This powerful yet simple tool accelerates the learning curve for beginners while improving productivity for professional developers, regardless of whether you're learning code, developing new features, or seeking improvement suggestions.
66

77
<p align="center">
88
<img src="./_images/app.gif" width="50%" alt="Animation">
99
</p>
1010

11+
## 👥 Target Users
12+
13+
- **Programming Beginners**: Understand open-source project structures and code logic through AI, accelerating your learning curve
14+
- **Software Developers**: Seamlessly integrate AI programming assistants into existing workflows to improve development efficiency
15+
- **Code Reviewers**: Quickly extract project module code and leverage AI for quality reviews and optimization suggestions
16+
- **Technical Educators**: Explain code structures and implementation details more effectively as teaching aids
17+
- **Open Source Contributors**: Rapidly familiarize yourself with new project codebases, lowering barriers to contribution
18+
19+
## 🎯 Key Application Scenarios
20+
21+
This tool allows you to easily pass code context to AI assistants for:
22+
23+
- **Code Learning**: Understanding complex project structures and mechanisms, improving learning efficiency
24+
- **Development Assistance**: Getting more accurate code modification and feature implementation suggestions
25+
- **Code Reviews**: Conducting automated quality checks and performance optimization analysis
26+
- **Refactoring Guidance**: Receiving code improvement suggestions based on complete context
27+
- **Problem Diagnosis**: Helping AI precisely locate issues by providing the complete environment
28+
29+
All features run locally without internet connection, ensuring the privacy and security of your code.
30+
1131
## 💡 Core Use Cases
1232

1333
### 1. Code Learning & Analysis
1434

15-
Let AI help you understand how complex codebases work:
35+
Easily let AI help you understand how complex codebases work:
1636

1737
1. **Select Target Project Directory**: Open the project you want to analyze
1838
2. **Copy Complete Project Structure**: Use the "Copy Directory Tree" function to help AI understand the overall architecture
@@ -36,7 +56,7 @@ Get AI programming assistance without disrupting your existing workflow:
3656

3757
Let AI become your code review assistant:
3858

39-
1. **Select Module for Review**: Use box selection for all files in a functional module
59+
1. **Select Module for Review**: Box-select all files in a functional module
4060
2. **Copy All Related Code with One Click**: Include complete implementation details and file paths
4161
3. **Request AI Review**: Get feedback on code quality, potential issues, and improvement suggestions
4262
4. **Implement Refactoring Suggestions**: Apply optimization solutions provided by AI

0 commit comments

Comments
 (0)