Skip to content

工作流

这个页面用于介绍当前私有文档工作流如何把产品说明、截图计划和自动化结果组合成可发布文档。

1. 规划功能树

docs/product-docs-workflow 中维护功能结构、截图计划和场景清单。

2. 生成截图

通过 automationscripts 中的脚本生成中英文截图资产。

3. 写入用户指南

将稳定截图和说明整理到 docs/gitbook,供 GitBook 发布。

4. 展示项目能力

用 VitePress 的 site 目录展示项目背景、自动化流程和部署预览。

推荐目录

text
private-docs-workflow/
  docs/
    gitbook/                  # GitBook 用户文档
    product-docs-workflow/    # 文档规划和截图 manifest
  site/                       # VitePress 项目介绍页
  assets/
    screenshots/              # 截图源资产
  automation/                 # 截图自动化
  scripts/                    # 本地生成脚本

本地命令

bash
npm run site:dev
npm run site:build
npm run site:preview