🔬 Research Report Assistant - 研报助手

专业的行业研报撰写工具，从选题到成稿的全流程管理

English | 简体中文

---

简体中文

📖 项目简介

研报助手是一个帮助分析师从选题到成稿的全流程管理工具。它会：

• ✅ 从多个信息源生成选题
• ✅ 搭建研报框架
• ✅ 逐步撰写内容
• ✅ 生成审阅清单

核心特点：

• 📝 分阶段工作：每一步都需要你批准，不会自动乱跑
• 💾 进度自动保存：写到一半可以退出，下次继续
• 🚫 严禁编造数据：数据缺失时会明确标注

---

✨ 功能特性

功能	说明
🎯 智能选题生成	从 Twitter、微信、搜索等多个信息源生成选题方向
📝 分阶段写作	列大纲 → 写内容 → 审阅，每步都听你的指挥
💾 自动保存进度	写到一半可以暂停，下次继续
🚫 严禁编造数据	需要数据时明确提示，保证真实性
🔄 断点续传	从任何阶段恢复工作
⚡ 性能优化	全局缓存机制，提升响应速度

---

🎯 适用场景

• 行业研究报告撰写
• 投资分析报告
• 技术趋势分析
• 商业模式研究
• 市场调研报告

---

🚀 快速开始（重要！必读）

本节专门为不熟悉代码的用户准备，请仔细阅读。

---

📋 准备工作检查清单

在开始之前，你需要：

• Node.js - JavaScript 运行环境（>= 18.0.0）
• npm - 包管理工具（随 Node.js 自动安装）
• 命令行工具 - Windows 的 CMD 或 PowerShell

别担心，下面会详细教你怎么安装和检查。

---

步骤 1：检查是否已安装 Node.js

按 Win + R，输入 cmd，然后输入：

node --version

如果看到类似这样的输出：

v18.17.0

✅ 恭喜，你已经安装了 Node.js，可以直接跳到步骤 3

如果提示"不是内部或外部命令"： ❌ 说明没安装，请看步骤 2

---

步骤 2：安装 Node.js

方法 A：官网下载（推荐）

1. 打开浏览器，访问：https://nodejs.org
2. 点击 LTS 版本的下载按钮（长期支持版，推荐）
3. 双击下载的安装包
4. 一路点"下一步"安装完成
5. 重启命令行（重要！）

验证安装：

node --version
npm --version

两个都有输出版本号就说明安装成功了！✅

---

步骤 3：下载项目

方法 A：使用 Git（推荐，如果你安装了 Git）

# 克隆项目到本地
git clone https://github.com/hy0235/Research-report-assitant.git

# 进入项目目录
cd Research-report-assitant

方法 B：直接下载 ZIP

1. 访问：https://github.com/hy0235/Research-report-assitant
2. 点击绿色的 "Code" 按钮
3. 选择 "Download ZIP"
4. 解压到你想放的文件夹

---

步骤 4：安装依赖（重要！）

进入项目文件夹后，运行：

npm install

你会看到类似这样的输出：

npm WARN deprecated ...（一些警告，可以忽略）

added 14 packages, and audited 15 packages in 3s

found 0 vulnerabilities

✅ 看到 added XX packages 就说明安装成功了！

常见问题：

• ❓ 速度很慢？使用国内镜像：npm install --registry=https://registry.npmmirror.com
• ❓ 提示"npm 不是内部或外部命令"？说明 Node.js 没安装好
• ❓ 看到很多 WARN？警告可以忽略，只要最后是 added XX packages 就行

---

步骤 5：测试是否成功

运行帮助命令：

node run.js help

如果出现帮助信息，说明一切正常！ ✅

---

📚 如何使用

使用方式 1：Claude Code（最简单）

什么是 Claude Code？

• 就像 ChatGPT 的网页版，但是安装在电脑上的
• 可以和 AI 对话，让 AI 帮你写东西

如何使用：

1. 安装 Claude Code：https://claude.ai/download
2. 打开 Claude Code
3. 直接对话：

   运行 research-report 的 help 命令
   运行 research-report 的 topics "AI教育"
   运行 research-report 的 status 命令
   

就这么简单！ 不需要记住任何复杂的命令。

---

使用方式 2：命令行

如果你想直接用命令行：

# 查看帮助
node run.js help

# 生成选题
node run.js topics "AI教育"

# 搭建框架
node run.js outline "AI在K12教育中的应用"

# 撰写内容
node run.js write

# 审阅研报
node run.js review

# 查看状态
node run.js status

---

📖 完整文档

新手必读

• 📘 小白操作指南 - 强烈推荐！零门槛教程

  • 如何安装 Claude Code
  • 什么是 npm（通俗解释）
  • 如何运行 npm install
  • 完整的使用流程

• 📗 使用教程 - 完整的功能说明和示例

• 📙 兼容性说明 - 支持哪些 AI 应用

• 📕 开发者文档 - 技术架构

---

🎬 快速演示

示例：写一篇关于"AI教育"的研报

你: 运行 research-report 的 topics "AI教育"

AI: 给你20个选题方向：
    1. AI在K12教育中的应用 ⭐⭐⭐⭐⭐
    2. AI如何改变高等教育 ⭐⭐⭐⭐
    ...

你: 我选第1个

AI: 好的，开始搭建大纲...
    你的核心观点是什么？

你: AI可以因材施教，让每个孩子都有私人教师

AI: 明白了，生成大纲如下：
    ### 观点1：AI可以因材施教
    ...

你: 批准

AI: ✅ 大纲已保存，开始撰写内容...

---

🛠️ 核心命令

命令	说明	示例
help	显示帮助信息	node run.js help
topics	生成选题	node run.js topics "AI教育"
outline	搭建框架	node run.js outline "选题名称"
write	撰写内容	node run.js write
review	审阅研报	node run.js review
status	查看状态	node run.js status
resume	恢复阶段	node run.js resume topics-input
cache	缓存管理	node run.js cache --action=show

---

📂 项目结构

research-report/
├── index.js              # 主程序
├── run.js                # 命令行入口
├── server.js             # HTTP API 服务器
├── package.json          # 项目配置
├── .gitignore           # Git 忽略文件
├── README.md            # 项目说明（本文件）
├── 小白操作指南.md        # 新手教程（必读！）
├── 使用教程.md            # 完整教程
├── 兼容性说明.md          # 兼容性文档
└── CLAUDE.md             # 开发者文档

注意： node_modules 文件夹不在仓库里，因为：

• 体积太大（7.2 MB）
• 可以通过 npm install 自动安装
• 这是开源项目的标准做法

---

❓ 常见问题

Q1：我没有编程基础，能用吗？

A：完全可以！

• 如果使用 Claude Code，就像聊天一样简单
• 命令行方式也很简单，复制粘贴命令就行
• 小白操作指南专门为非程序员准备

Q2：npm install 速度很慢怎么办？

A：使用国内镜像

npm install --registry=https://registry.npmmirror.com

Q3：提示"找不到模块"怎么办？

A：可能是安装不完整

# 删除 node_modules
rmdir /s /q node_modules

# 重新安装
npm install

Q4：能在其他 AI 应用中使用吗？

A：可以！ 查看兼容性说明

支持的：

• ✅ Claude Code（推荐）
• ✅ Cursor
• ✅ Antigravity
• ✅ 任何支持命令行的工具

---

🤝 贡献

欢迎提交 Issue 和 Pull Request！

如何贡献：

1. Fork 本项目
2. 创建特性分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 开启 Pull Request

---

📄 开源协议

本项目采用 MIT License 开源协议。

简单来说：

• ✅ 可以自由使用、修改、分发
• ✅ 可以用于商业项目
• ✅ 需要保留原作者的版权声明

---

⭐ Star History

如果这个项目对你有帮助，请给个 Star ⭐

你的支持是我们持续更新的动力！

---

📞 联系方式

• 🐦 Twitter: @shenhh88
• 📧 Issues: GitHub Issues
• 👤 作者：hy0235

---

English

Features

• 🎯 Intelligent Topic Generation - Generate research topics from multiple sources
• 📝 Phased Writing - Outline → Write → Review, every step under your control
• 💾 Auto-save Progress - Pause anytime, resume later
• 🚫 No Fabricated Data - Explicit prompts when data is needed
• 🔄 Resume from Any Stage - Continue from where you left off
• ⚡ Performance Optimized - Global caching for faster response

Quick Start

# Clone the project
git clone https://github.com/hy0235/Research-report-assitant.git
cd Research-report-assitant

# Install dependencies
npm install

# Run help command
node run.js help

Documentation

• 📘 Beginner's Guide - Zero-barrier tutorial (Chinese)
• 📗 User Manual - Complete feature documentation (Chinese)
• 📙 Compatibility Guide - Claude Code, Cursor, Antigravity (Chinese)
• 📕 Developer Docs - Technical architecture (Chinese)

Core Commands

Command	Description	Example
help	Show help	node run.js help
topics	Generate topics	node run.js topics "AI Education"
outline	Create outline	node run.js outline "Topic Name"
write	Write content	node run.js write
review	Review report	node run.js review
status	Show status	node run.js status

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with ❤️ by hy0235

⭐ If this project helps you, please give it a Star!

⬆ Back to Top