帮助文档

文档

把需求、方案、接口说明和交付记录沉淀在同一个工作区里,让 AI 生成与人工修改可以连续协作。

文档标签页能做什么
适合沉淀 PRD、技术方案、接口说明、交付记录与 AI 生成的结构化 Markdown 文档。
Markdown 编辑 预览模式 AI 流式写入 导出与版本管理
编写
在线维护需求、设计、接口说明等项目文档,不需要额外切换到外部文档工具。
预览
支持编辑态与预览态切换,方便检查标题结构、Mermaid 内容和最终阅读效果。
追踪
AI会根据用户的每次需求,实时更新文档内容,确保文档与项目代码保持一致。

核心能力

文档列表与检索
支持文档列表、标题与内容摘要预览、搜索过滤,适合快速定位当前项目中已经沉淀的资料。
编辑与脏状态管理
系统会识别用户手动编辑的未保存内容,避免误判 AI 生成内容为未保存状态,方便您安心迭代。
目录与预览阅读
文档支持目录提取、标题跳转和预览模式,适合处理较长的需求文档、实施方案与接口说明。
流程图与 UML 图生成
支持生成流程图、时序图、类图等 UML 图表,把业务流程和系统结构可视化,便于评审与沟通。
导出与交付
支持导出文档结果,可用于项目汇报、客户确认、内部评审或进入正式交付流程。

典型使用流程

  1. AI 创建文档:让AI助手根据需求描述先生成项目所需的所有文档内容。
  2. 人工精修:在编辑器里补充业务细节、删除多余内容,并通过目录快速跳到目标章节。
  3. 预览验收:切换到预览模式检查 Markdown 排版、图表和最终阅读体验。
  4. 导出或提交:将文档导出,或结合 Git 操作继续纳入项目版本管理。
适合放在文档页里的内容

需求背景、业务流程、功能设计、接口设计、界面设计和数据库设计,都建议在这里集中维护。这样 AI 继续修改前后端代码时,也能和当前文档语义保持一致。

推荐文档类型

文档类型 适合记录的内容 使用建议
需求文档 目标用户、业务流程、页面结构、字段要求 在项目前期先定范围,后续继续作为 AI 修改依据
功能设计 架构说明、模块职责、异常处理 适合研发评审和多人协作前统一口径
接口设计 接口地址、请求参数、响应示例、错误码 与后端标签页配合,减少前后端沟通成本
界面设计文档 页面布局、交互流程、视觉规范、组件说明 适合前端开发前统一视觉与交互口径
数据库设计 数据表结构、字段类型、索引、关联关系 适合后端与数据库开发时保持一致
使用建议:如果项目已经在持续开发,建议将“需求、功能设计、接口设计、数据库设计”拆成多篇独立文档,而不是堆在一个文件里,后续搜索、导出和 AI 定向修改都会更顺手。