是否对复杂的命令行选项感到不知所措?本指南将介绍如何使用交互模式,这是一个对话式界面,可以简化文档处理过程的每一步。阅读完毕后,您将能够使用简单、自然的语言指令来创建、更新、本地化和发布您的文档。
交互模式是管理文档的推荐方法,因为它提供了一个引导式工作流程,无需记忆特定的命令及其参数。
启动交互式会话
要启动交互模式,请在项目的根目录中执行 chat 命令。
aigne doc chat
aigne doc chat此命令将启动交互式会话,系统会提示您输入指令。
核心功能
交互模式将多个核心功能集成到一个对话式界面中,从而简化了整个文档生命周期。您可以用通俗易懂的语言陈述您的目标,系统将执行必要的步骤。
创建文档
通过分析您项目的源代码,创建完整的文档结构和初始内容。
更新与优化
根据您的反馈或源代码的最新变更,修改特定文档或整个部分。
本地化内容
将您的文档本地化为多种支持的语言,以服务全球受众。
发布文档
遵循引导式流程发布您的文档,使其在线可用。
交互方式
您可以通过两种主要方式进行交互:
自然语言指令
描述您想要完成的任务。系统会解释您的请求并启动相应的工作流程。例如,您可以输入"为项目创建文档"或"将安装指南本地化为德语和法语"。
直接命令
您也可以通过在聊天提示符中直接输入其命令名称来调用特定功能,例如
update或publish。
可用命令
交互模式可以理解一组与其主要功能相对应的命令。虽然您可以使用自然语言触发这些功能,但也可以直接使用这些命令。
| 命令 | 描述 |
|---|---|
generate | 启动从源文件创建新文档结构和内容的工作流程。 |
update | 启动根据代码变更或用户反馈修改现有文档的流程。 |
translate | 开始将文档本地化为一种或多种支持语言的流程。 |
publish | 引导您完成在线发布文档的步骤。 |
init | 帮助为项目创建初始配置文件 (docsmith.config.js)。 |
clear | 从您的项目中移除创建的文件、配置和缓存数据。 |
prefs | 允许您查看和管理已保存的文档创建偏好设置。 |
evaluate | 评估您创建的文档的质量和完整性,并提供一份报告。 |
history | 显示文档的更新和变更历史。 |
exit | 终止交互模式会话并返回标准终端提示符。 |
交互示例
以下对话记录演示了使用交互模式创建新文档的典型工作流程。
You:
> 我需要为这个项目创建文档。
AI Assistant:
好的。我将为当前目录启动文档创建流程。
首先,我将分析您的项目以提出一个文档结构。这可能需要一些时间...
...
分析完成。我已创建了一个建议的结构。您想在创建内容之前查看它吗? (yes/no)
You:
> yes
AI Assistant:
(建议的文档结构将在此处显示供您审阅。)
...
您可以请求更改,例如"添加一个 API 身份验证指南"或"合并安装和设置指南"。如果结构正确,只需输入"continue"。
You:
> continue
AI Assistant:
很好。我现在将继续为每个文档创建内容。这可能需要一些时间,具体取决于您项目的大小。此交互展示了系统如何引导用户完成分析、审阅和内容创建,仅需要简单的基于文本的响应。
总结
交互模式提供了一种系统化和引导式的方法来管理文档。它将工具的全部功能整合到一个单一的对话界面中,确保了工作流程的精确和高效。
要查看交互模式的实际应用,请参阅创建文档指南,以获取分步演练。