项目简介

Specifai是一个开源桌面应用,旨在通过集成AI能力,简化和加速软件开发生命周期的需求管理、文档编写和任务分解过程。它帮助团队从概念快速转化为可执行的任务和文档,提高效率。

主要功能点

  • AI文档生成: 根据项目描述和技术细节,自动生成详细的商业需求 (BRD)、产品需求 (PRD)、非功能性需求 (NFR) 和用户界面需求 (UIR) 文档。
  • 智能对话编辑: 提供一个交互式聊天界面,允许用户与AI对话,实时编辑和完善已生成的需求文档,获取上下文相关的建议。
  • 业务流程可视化: 根据需求描述生成和管理业务流程图,提供可视化视图帮助理解流程。
  • 用户故事与任务: 将产品需求文档中的内容转化为可执行的用户故事和更细粒度的任务列表。
  • 版本控制集成: 所有生成的文档和文件都保存在用户指定的工作目录中,方便与外部版本控制系统(如Git)或同步服务(如OneDrive, Dropbox)配合使用。
  • 外部工具集成: 支持与Jira进行用户故事和任务的同步,允许将任务直接创建到Jira看板中;支持连接AWS Bedrock知识库,利用企业内部文档为AI提供更精准的上下文。
  • 多LLM模型支持: 允许用户配置和使用多种大语言模型提供者,包括Azure OpenAI、OpenAI Native、AWS Bedrock、Gemini、Anthropic、OpenRouter和Ollama。

安装步骤

  1. 下载应用: 访问Specifai项目的 GitHub Release页面,下载与您的操作系统(Windows, macOS, Linux)对应的最新版本桌面应用安装包。
  2. 安装应用: 运行下载的安装包,按照提示完成安装过程。
  3. 启动应用: 启动Specifai桌面应用程序。
  4. 设置工作目录: 首次启动时,应用会提示您输入用户名并选择一个本地文件夹作为工作目录。这个目录将用于存储您所有的Specifai项目文件。
  5. 配置LLM和集成: 在应用内的“Settings”或“设置”界面,配置您选择的大语言模型(LLM)提供者信息(如API Key, Endpoint等)以及其他外部集成(如Jira、AWS Bedrock)。正确的配置是使用AI功能的必要前提。

服务器配置 (MCP客户端使用)

Specifai的后端(即MCP服务器)与Specifai桌面客户端(UI)通过Electron的进程间通信(IPC)机制进行交互,而非典型的网络服务。因此,对于使用Specifai官方桌面客户端的用户来说,无需进行额外的服务器配置。

如果开发者希望构建一个独立的MCP客户端来与Specifai后端交互(前提是Specifai的设计允许此类外部IPC连接),理论上的MCP客户端配置可能需要指定Specifai可执行文件的路径作为 'command'。但请注意,Specifai主要设计为一体化的桌面应用,其后端通信方式是为内部Electron客户端优化的IPC,与标准的网络MCP服务器有所不同。

典型的MCP客户端配置格式(仅供参考,实际配置需依据Specifai后端是否支持外部连接及其具体接口而定,官方客户端无需此步骤):

{
  "serverName": "Specifai Local Backend",
  "command": "/path/to/Specifai/Specifai.exe", // 替换为Specifai可执行文件路径
  "args": [], // 启动参数,通常Specifai作为Backend运行时可能有特定参数,但未公开
  "protocol": "ipc" // 或者其他Electron IPC相关的标识
}

由于Specifai主要通过Electron IPC与自带UI通信,外部MCP客户端能否连接并如何连接,取决于Specifai后端是否暴露了标准的IPC或其他接口供外部调用。

基本使用方法

  1. 创建新项目: 在应用内点击“Create Solution”或类似按钮,输入项目的名称、描述和技术细节。
  2. 生成需求文档: 根据项目信息,您可以选择是否使用AI生成初始的BRD、PRD、NFR、UIR等文档。
  3. 浏览和编辑文档: 在项目视图中,导航到不同的文件夹(BRD, PRD等),打开文件进行编辑。您可以使用富文本编辑器或AI聊天功能来修改文档内容。
  4. 生成用户故事/任务: 在PRD文档视图下,找到生成用户故事/任务的选项,利用AI能力将需求细化。
  5. 管理任务: 查看和编辑用户故事下的任务列表。
  6. 使用集成: 配置并使用Jira集成将用户故事和任务同步到Jira;配置AWS Bedrock知识库为AI对话提供更多背景信息。

信息

分类

开发者工具