读取项目资料
扫描项目目录中的 Markdown、Word、PDF,以及 OpenSpec、Spec Kit、Comet、Superpowers 等 SDD 资料。
读取项目目录中的资料,生成帮助目录与章节正文,再输出可独立托管的帮助站点。
扫描项目目录中的 Markdown、Word、PDF,以及 OpenSpec、Spec Kit、Comet、Superpowers 等 SDD 资料。
按模块、特性、场景组织面向用户任务的目录,并可在文档创作中调整章节结构。
使用可视化编辑器维护项目首页区块,发布时与帮助文档一起输出。
帮助文档与项目网站均发布为静态 HTML,预览与导出共用同一套模板与样式。
按项目、资料、目录、发布四个环节推进,每一步都可以在本地确认结果。
选择 Web 或移动应用,填写项目目录、访问地址与文档语言。
扫描项目目录中的需求文档、普通文档与代码结构,确认文档生成依据。
生成模块、特性、场景三层目录,再逐章生成和调整正文。
在本地预览帮助站点,发布帮助文档,并可同时发布项目网站。
帮助文档写入项目的 `udocs-docs/` 目录,`README.md`、`_sidebar.md` 与 `chapters/` 下的章节文件就是数据源,可以直接编辑、版本管理和交接。
关于运行方式、文档存储与发布产物的说明。
不需要。UDocs 是本地单用户工具,当前控制台无需登录或注册。
保存在项目目录的 udocs-docs/ 中,README.md、_sidebar.md 与章节 Markdown 文件可直接编辑和管理。
支持 Web 应用,以及 Android、iOS、HarmonyOS 移动应用项目。
不需要。帮助文档与项目网站发布为独立静态 HTML,可单独托管。
准备好项目目录后,先阅读帮助文档,按步骤创建项目、读取资料并生成第一份帮助文档。