Skip to content

Latest commit

 

History

History
911 lines (640 loc) · 19.8 KB

File metadata and controls

911 lines (640 loc) · 19.8 KB

研报助手 - 小白操作指南 📝

专为文科生设计的零门槛研报撰写教程


🚀 如何开始使用(必读!)

在开始之前,你需要先准备好工具。别担心,很简单!


第1步:确认你有没有 Claude Code

什么是 Claude Code?

  • 就像 ChatGPT 的网页版,但是是专门安装在电脑上的
  • 可以和 AI 对话,让 AI 帮你写东西、查资料
  • 官方出品,安全可靠

怎么检查有没有安装?

  1. Win + R 键(Windows)
  2. 输入 cmd 然后回车
  3. 在出现的黑框里输入:claude
  4. 如果出现了一个对话窗口,说明已经安装了 ✅
  5. 如果提示"找不到命令",说明没安装,看下一步

第2步:下载安装 Claude Code(如果还没有)

方法 A:最简单(推荐)

  1. 打开浏览器,访问:https://claude.ai/download
  2. 下载 Windows 版本(会自动检测你的系统)
  3. 双击下载的安装包
  4. 一路点"下一步"安装完成
  5. 桌面上会出现一个 Claude 图标

方法 B:如果下载不了(国内网络问题)

可以在命令行安装(需要先安装 Node.js):

npm install -g @anthropic-ai/claude-code

第3步:打开 Claude Code

方式 A:双击图标(最简单)

  • 在桌面找到 Claude 图标
  • 双击打开
  • 会弹出一个聊天窗口

方式 B:命令行打开

  1. Win + R
  2. 输入 cmd 回车
  3. 输入 claude 回车
  4. 等待聊天窗口打开

方式 C:VS Code 插件 如果你用 VS Code 写代码:

  1. 打开 VS Code
  2. 点击左侧的扩展图标(四个方块)
  3. 搜索 "Claude Code"
  4. 安装插件
  5. 点击右侧的 Claude 图标打开

第4步:确认研报助手已安装

在 Claude Code 的对话框里输入:

运行 research-report 的 help 命令

如果出现了一大堆帮助信息,说明:

  • ✅ 研报助手已经安装好了
  • ✅ 可以直接使用了

如果提示找不到或出错:

  • 别慌,看下面的"常见问题"

❓ 常见问题(安装阶段)

Q1:我没有管理员权限怎么办? A:

  • 可以选择"为当前用户安装"
  • 或者找管理员帮忙安装

Q2:下载速度很慢/打不开官网? A:

  • 可能需要科学上网
  • 或者使用命令行安装(方法 B)

Q3:安装后找不到图标? A:

  • 在开始菜单搜索 "Claude"
  • 或者用命令行 claude 打开

Q4:提示"找不到 research-report"? A:

  • 研报助手可能没有正确安装
  • 检查文件夹是否存在:C:\Users\你的用户名\.claude\skills\research-report
  • 如果不存在,需要重新安装研报助手

📌 其他使用方式(非 Claude Code 用户)

如果你用的是其他 AI 工具:

你使用的工具 如何使用研报助手
Cursor 查看教程目录下的《兼容性说明.md》
Antigravity 查看教程目录下的《兼容性说明.md》
其他聊天应用 查看教程目录下的《兼容性说明.md》
只用命令行 直接运行 node run.js help

重要提示:

  • Claude Code 是官方推荐的方式,最简单
  • 其他方式可能需要额外配置
  • 小白用户建议用 Claude Code

✅ 准备工作检查清单

在开始使用之前,确认:

  • 已安装 Claude Code
  • 能正常打开 Claude Code
  • 输入"运行 research-report 的 help 命令"能看到帮助信息
  • 大概知道这个工具是干什么的(看下一章)

全部勾选了?太好了!继续往下看吧! 👇


📦 什么是 npm(重要!必读)

如果你不懂代码,这一章一定要看!用最简单的话讲明白 npm 是什么。


❓ 什么是 npm?

用生活中的例子来解释:

想象你要做一道菜:

传统方式:

  1. 写下菜谱(需要哪些食材)
  2. 自己去买菜(跑很多超市)
  3. 洗菜、切菜
  4. 开始做菜

有"助手"的方式:

  1. 写下菜谱(告诉助手需要什么)
  2. 助手自动去采购(一次性买齐)
  3. 助手把食材准备好
  4. 你直接开始做菜

npm 就是这个"助手"!

npm = Node Package Manager(Node 包管理器)
      = 一个帮你自动下载和安装工具的小助手

🎯 为什么需要 npm?

研报助手用到了一些别人写好的工具:

比如:

  • 处理文件的工具
  • 解析命令的工具
  • 连接网络的工具

如果没有 npm:

  • ❌ 你要自己去网上找这些工具
  • ❌ 一个一个下载
  • ❌ 可能版本不对
  • ❌ 可能下载到假货

有了 npm:

  • ✅ 只需要一个命令:npm install
  • ✅ 自动从官方仓库下载
  • ✅ 自动安装正确的版本
  • ✅ 几秒钟就完成

📝 package.json 是什么?

用购物清单来类比:

package.json = 购物清单
npm install    = 根据清单采购
node_modules/  = 买回来的东西

package.json 里面写着:

{
  "dependencies": {
    "express": "^4.18.0",        // 需要 express 版本 4.18.0
    "cors": "^2.8.5"            // 需要 cors 版本 2.8.5
  }
}

就像购物清单:

  • 牛奶 1 箱
  • 鸡蛋 10 个
  • 面包 1 袋

🛠️ 如何安装和使用 npm?

重要:npm 和 Node.js 是绑定在一起的!

第1步:检查电脑有没有 Node.js

Win + R,输入 cmd,然后输入:

node --version

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

v18.17.0

说明已经安装了 Node.js(也就有了 npm)✅

如果提示"不是内部或外部命令": 说明没安装,看下一步


第2步:安装 Node.js(如果没有)

方法 A:官网下载(推荐)

  1. 打开浏览器,访问:https://nodejs.org
  2. 会看到两个版本:
    • LTS 版本(长期支持版,推荐)← 选这个
    • Current 版本(最新版,可能有 bug)
  3. 点击 LTS 版本的下载按钮
  4. 双击下载的安装包
  5. 一路点"下一步"安装完成
  6. 重启电脑(或者重启命令行)

方法 B:如果官网打不开(国内网络问题)

  1. 访问国内镜像:https://npmmirror.com/
  2. 下载对应的安装包
  3. 安装步骤同上

第3步:验证安装成功

打开新的命令行窗口,输入:

node --version
npm --version

应该看到类似:

C:\>node --version
v18.17.0

C:\>npm --version
9.6.7

两个都有输出版本号,说明安装成功!


🚀 如何运行 npm install?

场景 1:从 GitHub 下载了研报助手

假设你下载到了:C:\Users\你的用户名\research-report

步骤:

  1. 打开命令行

    • Win + R
    • 输入 cmd
    • 回车
  2. 进入项目文件夹

    cd C:\Users\你的用户名\research-report
  3. 运行安装命令

    npm install
  4. 等待完成

    • 你会看到一堆文字滚动
    • 最后显示类似:
      added 14 packages, and audited 15 packages in 3s
      found 0 vulnerabilities
      
    • ✅ 表示安装成功!
  5. 可以开始使用了

    node run.js help

🎬 完整演示(从下载到使用)

假设你是第一次使用:

第1步:从 GitHub 下载项目

  1. 访问:https://github.com/hy0235/research-report
  2. 点击绿色的 "Code" 按钮
  3. 选择 "Download ZIP"
  4. 解压到你想放的文件夹,比如:C:\Users\你的用户名\research-report

第2步:打开命令行并进入文件夹

# 进入项目文件夹
cd C:\Users\你的用户名\research-report

# 查看文件夹内容(可选)
dir

第3步:安装依赖

npm install

你会看到:

C:\Users\你的用户名\research-report>npm install
npm WARN deprecated ...(一些警告,可以忽略)

added 14 packages, and audited 15 packages in 5s

found 0 vulnerabilities

第4步:测试是否成功

node run.js help

如果出现帮助信息,说明一切正常!


⚠️ 常见问题(npm 相关)

Q1:npm install 速度很慢怎么办?

A:使用国内镜像加速

# 临时使用(推荐)
npm install --registry=https://registry.npmmirror.com

# 或者永久设置(只需要设置一次)
npm config set registry https://registry.npmmirror.com

设置后,以后每次 npm install 都会自动使用国内镜像,速度快很多!


Q2:提示 "npm 不是内部或外部命令"

A:说明 Node.js 没安装或没安装好

解决方法:

  1. 重新安装 Node.js
  2. 安装后重启命令行
  3. 再试 npm --version

Q3:npm install 时报错 "ENOSPC"

A:磁盘空间不够

解决方法:

  • 清理磁盘空间
  • 或者换个磁盘(比如 D 盘)

Q4:安装后运行 node run.js help 提示找不到模块

A:可能安装不完整

解决方法:

# 删除 node_modules 文件夹
rmdir /s /q node_modules

# 重新安装
npm install

# 或者用清理缓存的方式
npm cache clean --force
npm install

Q5:看到很多 WARN(警告)信息

A:警告可以忽略,不影响使用

重点看最后几行:

  • 如果是 added XX packages → 成功 ✅
  • 如果是 found 0 vulnerabilities → 没有安全漏洞 ✅

只有出现 ERR! 才是真正的错误。


💡 重要提示

npm install 只需要运行一次!

第一次下载项目:
  npm install  ← 只需要这一次
  以后每次打开项目:
  直接用就行,不需要再运行 npm install

什么时候需要重新运行 npm install?

  1. 刚从 GitHub 下载项目时
  2. 删除了 node_modules 文件夹后
  3. package.json 内容发生变化后
  4. 换了一台电脑时

🎯 总结(记住这几点)

  1. npm = 自动下载工具的小助手
  2. npm install = 自动安装所需的工具
  3. 只需运行一次,以后就不用了
  4. 如果报错,检查 Node.js 是否安装
  5. 速度慢就用国内镜像

📞 需要帮助?

如果遇到 npm 相关问题:

  1. 查看 Node.js 版本

    node --version
    npm --version
  2. 检查是否在正确的文件夹

    # 应该能看到 package.json
    dir
  3. 清理缓存重试

    npm cache clean --force
    npm install
  4. 查看详细错误信息

    npm install --verbose

现在你知道 npm 是什么了,继续往下看吧! 👇


💡 一句话介绍

研报助手 = 你的私人写作教练

就像写作文之前先列提纲,然后一段一段写,最后检查修改。研报助手帮你做这些事,但不会自作主张,每一步都听你的指挥


🎯 这东西是干什么的?

想象你要写一篇关于"AI如何改变教育"的深度文章:

传统方式:

  1. 自己想写什么
  2. 自己列大纲
  3. 自己写内容
  4. 自己检查
  5. 写到一半卡住了……😰

有了研报助手:

  1. ✅ 它给你20个选题方向,你选一个
  2. ✅ 它帮你列好详细大纲,你点头它才继续
  3. ✅ 它帮你一段一段写,你可以随时改
  4. ✅ 它帮你检查有没有问题
  5. ✅ 写到一半可以暂停,下次继续 😊

🚀 核心原则(记这个就够了!)

1️⃣ 你说了算

  • 每一步都要你批准才继续
  • 不满意随时说"重写"
  • 你是老板,AI是助手

2️⃣ 不会瞎编

  • AI不会编造数据和事实
  • 需要数据时会明确告诉你
  • 必须你提供真实数据才继续

3️⃣ 随时暂停

  • 写到一半可以退出
  • 下次回来继续写
  • 进度自动保存,不会丢失

📖 完整操作流程(保姆级教程)

📍 第1步:看看有哪些选题

你说:

运行 research-report 的 topics 命令

或者,如果你已经有想写的主题:

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

AI会问你:

  • "你想要从哪里获取选题信息?"
  • "比如:Twitter热点、微信群聊、某个网页链接"
  • "或者直接告诉我你想写的主题"

你要做的:

  • 给AI一些信息(比如粘贴一些文章链接、群聊记录)
  • 或者直接说你感兴趣的主题

📍 第2步:AI给你20个选题,你选一个

AI会给你:

1. AI在K12教育中的应用 - 数据可行性:⭐⭐⭐⭐⭐
2. AI如何改变高等教育 - 数据可行性:⭐⭐⭐⭐
3. AI教育的商业模式分析 - 数据可行性:⭐⭐⭐
...(一共20个)

你要做的:

  • 选一个你喜欢的,比如"我选第1个"
  • 或者说"我想把第1个和第3个合并"
  • 或者提出你自己的想法

📍 第3步:搭建写作大纲

你说:

运行 research-report 的 outline "AI在K12教育中的应用"

AI会问你:

  • "你的核心观点是什么?"
  • "为什么这个观点重要?"
  • "有哪些论据支撑?"

你要做的:

  • 告诉AI你的想法(用大白话就行)
  • 比如:"我觉得AI可以因材施教,让每个孩子都有私人教师"

AI会生成:

  • 一份详细的写作大纲
  • 每个观点要写什么
  • 需要哪些数据和图表

你要做的:

  • 仔细看大纲
  • 说"批准"或"这里要改一下"

📍 第4步:开始写内容

你说:

运行 research-report 的 write 命令

AI会开始写:

### 观点1:AI可以因材施教

传统教育模式是一个老师对几十个学生,很难照顾到每个人的特点...

可能遇到的情况:

情况1:AI需要数据

AI:为了证明"AI可以提高学习效率",我需要数据。
     你有相关的实验数据或研究报告吗?

你说:

  • "有,我有个研究报告说..."
  • 或者"先跳过,我稍后补"

情况2:你想修改内容

你:这段太啰嗦了,精简一点
AI:✅ 好的,这是精简版...

特点:

  • 一段一段写,不是一次性全写完
  • 写完一段可以改,改好了再写下一段
  • 随时可以暂停,下次继续

📍 第5步:检查修改

你说:

运行 research-report 的 review 命令

AI会给你一份检查清单:

✅ 核心检查项:

1. 逻辑一致性
   □ 核心观点清晰吗?
   □ 论证逻辑严密吗?

2. 数据真实性(最重要!)
   □ 所有数据都有真实来源吗?
   □ 有没有编造的数据?

3. 论证充分性
   □ 每个观点有足够的论据吗?

你要做的:

  • 逐项检查
  • 发现问题告诉AI修改
  • 最后确认没问题了,完成!

🎨 研报长什么样?(给你看个模板)

标题:AI在K12教育中的应用分析

观点总结(4-6条,每条30-50字)

  1. AI可实现真正的因材施教,根据每个学生的学习进度定制内容
  2. AI教师可以解决教育资源不均的问题,让偏远地区也能享受优质教育
  3. ...

观点1:AI可实现真正的因材施教(1000字+)

  • 论据1:传统教育模式的局限性

    • 数据支持:班级人数与学习效果的相关性研究
    • 图表:传统课堂 vs AI辅助课堂对比图
  • 论据2:AI如何实现个性化学习

    • 数据支持:某AI教育平台的使用效果数据
    • ...

核心内容

  • 行业头部玩家分析:科大讯飞、好未来等公司的商业模式
  • 未来格局演变:AI会如何改变5年后的教育行业
  • 参与者转变:传统教师的角色会怎么变

估值指标创新(可选)

  • 创建新的衡量指标:"教育效果指数 = 学习效率提升 × 成本降低 × 可及性提升"
  • 用严谨逻辑说明这个指标的合理性

❓ 常见问题(小白必看)

Q1:我不会写代码,能用吗?

A: 完全可以!你只需要:

  • 打开Claude Code
  • 用中文和AI对话
  • 就像聊天一样简单

Q2:我完全不懂某个行业,能用吗?

A: 可以!

  • AI会帮你分析信息
  • 但你最好对要写的主题有一定了解
  • 毕竟最后是你来确认内容对不对

Q3:AI会不会胡编乱造?

A: 不会!

  • AI缺数据时会明确告诉你
  • 不会自己编造数据
  • 所有数据都需要你提供或确认

Q4:写到一半可以暂停吗?

A: 可以!

  • 随时可以退出
  • 下次说"运行 research-report 的 status 命令"查看进度
  • 或者说"继续写"就能接着写

Q5:我对AI生成的内容不满意怎么办?

A: 直接告诉AI!

  • "这段太啰嗦了,精简一点"
  • "这里逻辑不对,应该是..."
  • "这个例子不好,换个更生动的"
  • AI会根据你的反馈修改

Q6:我能看到写到哪里了吗?

A: 当然!

  • 说"运行 research-report 的 status 命令"
  • 会显示当前写到哪一步了
  • 还能看到之前保存的各个版本

📝 快速命令速查表

你想做什么 → 你要说什么:

想做什么 直接说这个
查看帮助 运行 research-report 的 help 命令
生成选题 运行 research-report 的 topics "你的主题"
搭建大纲 运行 research-report 的 outline "你的选题"
开始写 运行 research-report 的 write 命令
检查修改 运行 research-report 的 review 命令
查看进度 运行 research-report 的 status 命令

🌟 实战示例(从零到完成)

假设你想写关于"短视频对青少年影响"的研报

第1天:

你:运行 research-report 的 topics "短视频教育"

AI:给你20个选题...

你:我选第5个:短视频如何影响青少年的注意力

AI:好的,接下来要搭建大纲吗?

你:运行 research-report 的 outline "短视频如何影响青少年的注意力"

AI:你的核心观点是什么?

你:我觉得短视频让青少年难以集中注意力阅读长文章

AI:明白了,我生成了一份大纲...

你:批准

第2天(中间去睡觉了):

你:运行 research-report 的 status 命令

AI:你写到"大纲搭建完成"阶段了

你:运行 research-report 的 write 命令

AI:开始写第1段...

你:这段写得不错,继续

AI:写第2段,但需要一些研究数据支持...

你:有个研究说青少年平均每天刷短视频3小时,你加上去

AI:✅ 已添加...

(中途你去开会了)

第3天:

你:继续写

AI:从第3段继续...

(写完后)

你:运行 research-report 的 review 命令

AI:检查清单如下...

你:这里有个数据我需要核实一下...

AI:好的,标注出来了

你:其他都没问题,完成!

AI:✅ 研报已完成!已保存到...

💡 小贴士(让写作更顺畅)

1. 准备工作

  • 提前收集一些相关资料(文章、数据、案例)
  • 对要写的主题有自己的想法
  • 准备一些真实数据来源

2. 写作技巧

  • 用大白话告诉AI你的想法
  • 不满意就说"重写"或"改一下"
  • 随时可以暂停,不着急一次写完

3. 注意事项

  • AI不会编造数据,所以你要准备好真实数据
  • 最后一定要review(检查)一遍
  • 确认所有数据和事实都正确

🎊 总结

研报助手就是:

  1. 选题顾问 - 帮你找到好的写作方向
  2. 大纲助手 - 帮你列好写作框架
  3. 内容助手 - 帮你一段一段写
  4. 审稿助手 - 帮你检查修改

使用方法:

  • 用中文对话
  • 想说什么就说什么
  • 不满意随时改
  • 随时暂停休息

最重要的一点:

你是老板,AI是助手。你说怎么写,AI就怎么写。


📞 遇到问题?

忘记命令了?

运行 research-report 的 help 命令

不知道写到哪了?

运行 research-report 的 status 命令

想重新开始?

运行 research-report 的 cache --action=clear 命令

开始你的第一篇研报吧! 🚀

记住:就像和朋友聊天一样简单。


最后更新:2025年1月 版本:小白友好版 v1.0