WordCraftAI

项目介绍

WordCraftAI 是一个 Microsoft Word 的智能插件，基于 Office Add-in 技术，使用 React 框架构建。该工具旨在通过 AI 增强文档创作体验，提供文本生成、编辑和优化功能。通过集成 OpenAI API，WordCraftAI 可以帮助用户更高效地创建和编辑文档内容。

功能特点

• 智能对话：基于 OpenAI 的智能文本生成和编辑，提供上下文相关的写作建议
• 任务管理：设置文档创作的要求、目标受众和写作风格
• 大纲生成：根据要求自动生成并编辑文档结构大纲
• 全文生成：基于大纲自动生成完整文档内容
• 文本润色：提供语法检查、风格优化和内容改进建议
• 与 Microsoft Word 无缝集成：直接在文档中插入和编辑内容
• 现代化 Fluent UI 界面：提供直观、美观的用户体验

应用截图

（注：此处可添加实际应用截图）

技术栈

• 前端：
  • React 18
  • TypeScript
  • Fluent UI React 组件
  • Office JS API
• AI 集成：
  • OpenAI API
• 构建工具：
  • Webpack
  • Babel

开始使用

系统要求

• Node.js 16.x 或更高版本
• npm 8.x 或更高版本
• Microsoft Word（桌面版或网页版）

安装依赖

# 克隆项目
git clone https://github.com/your-username/wordcraftai.git
cd wordcraftai

# 安装依赖
npm install

配置环境变量

在项目根目录创建 .env 文件并配置：

OPENAI_API_KEY=your_api_key_here

开发环境运行

# 启动开发服务器
npm start

启动后，Word 将自动打开并加载插件。如果未自动打开，可以手动在 Word 中加载插件。

构建项目

npm run build

构建后的文件将位于 dist 目录中。

项目结构

• src/: 源代码目录
  • taskpane/: 任务窗格相关组件
    • components/: UI 组件
      • panels/: 各功能面板组件
        • ChatPanel.tsx: AI 对话功能
        • RequirementsPanel.tsx: 文档要求设置
        • OutlinePanel.tsx: 大纲生成与编辑
        • FullContentPanel.tsx: 全文生成
        • PolishPanel.tsx: 文本润色工具
    • taskpane.ts: 任务窗格核心功能
  • commands/: 功能命令和按钮
  • utils/: 工具函数和辅助类
• manifest.xml: Office 加载项清单文件

核心功能模块

1. AI 对话模块

提供与 AI 助手的交互界面，可以询问写作相关问题，获取建议，并直接将生成的内容插入到文档中。

2. 任务要求设置

用户可以定义文档的标题、关键点、目标受众和语调风格，为后续的内容生成提供基础。

3. 大纲编辑与生成

根据用户设定的任务要求，自动生成文档结构大纲，并支持用户编辑和调整。

4. 全文生成

基于大纲结构和任务要求，生成完整的文档内容，并提供预览和编辑功能。

5. 文本润色工具

提供语法检查、风格统一、表达优化等功能，帮助用户改进文档质量。

环境变量

项目使用 .env 文件存储配置信息，请在运行前配置：

OPENAI_API_KEY=your_api_key_here

贡献指南

欢迎贡献代码、报告问题或提出改进建议！

1. Fork 本仓库
2. 创建你的特性分支 (git checkout -b feature/amazing-feature)
3. 提交你的更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 提交 Pull Request

开发路线图

• 支持更多语言模型选择
• 添加模板库功能
• 改进协同编辑支持
• 添加更多文档类型支持
• 性能优化

许可证

MIT

联系方式

如有问题或建议，请通过 Issues 联系我们。