文档变更日志 - PDF Connect v3
2026-02-21 手动 URL 区块更新
- 新增指南:
manual-url-blocks.md - 更新发布/设置/查看器/展示相关文档,涵盖手动产品模板区块说明
- 补充了关联模式与手动模式的行为区别说明
- 新增手动模式专属故障排查步骤
- 更新侧边栏导航,加入新指南入口
概述
本变更日志记录了 PDF Connect v3 的完整文档改造进度。v3 版本新增了全站页面关联功能、增强的发布工作流以及改进的界面体验。
状态说明
- ✅ 已完成 - 文件已更新 v3 内容,待提供新截图
- 🔄 进行中 - 文件正在更新
- ❌ 待更新 - 旧文件,需进行 v3 改造
- 📸 需要截图 - 内容已更新,待添加新图片
已更新文件(v3)
核心 指南 - 已完成 ✅
intro-v3.md ✅
- 状态:已完成,待截图
- 变更内容:
- 更新至描述三种展示样式(嵌入式 PDF、PDF 按钮、PDF 列表)
- 新增全站关联功能说明(支持所有页面类型)
- 强调简化的两步发布工作流
- 增加成功案例与业务价值说明
- 旧文件:
intro.md→intro-old.md - 所需截图:已在 SCREENSHOT_REQUIREMENTS.md 中确定 8 张关键截图
tutorial-basics/link-pdfs-v3.md ✅
- 状态:已完成,待截图
- 变更内容:
- 针对全站关联功能(所有页面类型)进行全面重写
- 增强搜索、分页和批量选择功能说明
- 添加跨页面关联策略与故障排查指南
- 在适当位置添加截图占位符
- 旧文件:
tutorial-basics/link-pdfs.md→tutorial-basics/link-pdfs-old.md - 所需截图:已确定 12 张关键截图
tutorial-basics/place-linked-pdf-v3.md ✅
- 状态:已完成,待截图
- 变更内容:
- 更新以反映新的发布弹窗系统
- 新增三种不同展示样式及详细使用场景说明
- 增强模板选择与多区块策略说明
- 新增性能优化与故障排查章节
- 旧文件:
tutorial-basics/place-linked-pdf.md→tutorial-basics/place-linked-pdf-old.md - 所需截图:已确定 15 张关键截图
publishing-workflow-v3.md ✅
- 状态:新文件,已完成,待截图
- 目的:针对新发布系统的完整工作流指南
- 内容:
- 详细的最佳实践与故障排查说明
- 模板管理策略
- 性能与用户体验优化
- 所需截图:已确定 8 张工作流专属截图
待更新文件 ❌
基础教程
tutorial-basics/upload-a-pdf.md❌ - 需更新 v3 界面tutorial-basics/account-and-subscription.md❌ - 内容可能无变化tutorial-basics/paste-pdf-id.md❌ - 可能为旧版功能tutorial-basics/place-non-prd-page.md❌ - 已被全站关联功能替代tutorial-basics/place-linked-pdf-legacy.md❌ - 旧版方法,考虑归档
进阶教程
tutorial-extras/link-pdfs-bulk.md❌ - 需更新 v3 批量操作界面tutorial-extras/external-pdfs.md❌ - 需更新 v3 界面tutorial-extras/pdf-viewers.md❌ - 需更新 v3 查看器选项tutorial-extras/using-tags.md❌ - 需更新 v3 标签界面tutorial-extras/translate-your-site.md❌ - 内容可能无变化
旧版功能
legacy/button-designer.md❌ - 已被主题编辑器区块替代legacy/pdf-placement.md❌ - 已被发布工作流替代
截图需求
优先级 1 - 核心工作流 📸
- 应用概览:PDF 管理主界面
- 关联界面:新的页面类型下拉菜单与选择操作
- 发布弹窗:三种展示样式选项
- 主题编辑器:向模板添加 PDF 区块
- 资源选择:搜索与分页操作示例
优先级 2 - 高级功能 📸
- 多区块模板:同一页面不同样式的示例
- 批量操作:电子表格导入界面
- 设置与自定义:区块配置选项
- 移动端视图:PDF 在移动设备上的显示效果
- 性能工具:数据分析与优化功能
优先级 3 - 使用场景 📸
- 产品手册示例:产品页面中的嵌入式 PDF
- 分类目录:分类页面上的 PDF 列表
- 博客资源:文章页面上的 PDF 按钮
- 首页展示:首页中的 PDF 集成
- 错误状态:出现问题时用户看到的页面
截图拍摄注意事项
需要截取的界面元素:
- 新的下拉菜单与选择界面
- 体验优化后的弹窗
- 主题编辑器集成入口
- 移动端响应式视图
- 错误与加载状态
需要准备的内容示例:
- 带有真实名称/描述的示例 PDF
- 测试用产品、分类、文章、页面
- 不同大小和类型的 PDF 文件
- 移动设备测试环境
前后对比:
- 新旧关联界面对比
- 旧版放置方法与主题编辑器区块对比
- 仅限产品 vs. 全站关联对比
- 单一展示样式 vs. 多种选项对比
迁移策略
第一阶段:核心文档 ✅
- 更新主要工作流指南
- 创建完整的功能说明文档
- 建立新的文件命名规范
第二阶段:详细指南 🔄
- 更新上传与账户指南
- 改造批量操作文档
- 更新外部 PDF 与查看器指南
第三阶段:旧版内容管理 📋
- 归档已被替代的旧功能
- 为现有用户创建迁移指南
- 更新导航与交叉引用
第四阶段:视觉优化 📸
- 协调截图拍摄工作
- 替换所有占位图片
- 为复杂工作流添加视频教程
- 与真实商家测试文档
已实施的文档改造体系 ✅
文件管理策略
- 命名规范:所有新文件使用
-v3后缀便于识别 - 旧文件保留:原始文件重命名为
-old后缀以供参考 - 变更追踪:完整的变更日志,含状态更新与截图需求
图片管理策略
- 旧图片已删除:所有过时截图已从文档中移除
- 策略性占位符:在视觉内容有价值的位置放置
[需要截图:描述] - 需求文档:在专属文件中记录完整截图需求
- 优先级体系:三级优先级截图拍摄系统
质量保证流程
- 内容审查:所有 v3 文件已审核准确性与完整性
- 链接验证:内部链接已更新指向 v3 版本
- 一致性检查:所有文件格式与术语统一规范
- 可访问性:已规划替代文本需求与描述性占位符
已成功改造的文件
核心文档 ✅
intro-v3.md- 含 v3 功能的主要介绍tutorial-basics/link-pdfs-v3.md- 全站关联指南tutorial-basics/place-linked-pdf-v3.md- 增强版发布指南publishing-workflow-v3.md- 完整工作流指南
支持性文档 ✅
DOCUMENTATION_CHANGELOG.md- 变更追踪与状态SCREENSHOT_REQUIREMENTS.md- 视觉内容规划
下一阶段文件(已规划)
getting-started-v3.md- 现代化入门指南advanced-features-v3.md- 高级用户功能tutorial-basics/upload-a-pdf-v3.md- 更新版上传流程tutorial-extras/link-pdfs-bulk-v3.md- 增强版批量操作
该系统方法确保:
- 零内容丢失:所有原始内容完整保留
- 清晰的进度追踪:一目了然地查看完成情况与待办事项
- 专业质量:统一、现代的文档标准
- 面向未来:可扩展的持续更新体系
成功指标
文档质量:
- 所有 v3 功能均有完整说明
- 从 v2 到 v3 的清晰迁移路径
- 减少关于新功能的支持工单
- 商家对文档清晰度的正面反馈
视觉优化:
- 反映当前界面的现代截图
- 所有指南中统一的视觉语言
- 针对移动端优化的文档体验
- 针对复杂工作流的视频补充内容
本次改造将确保我们的文档质量与 PDF Connect v3 新功能的水准相匹配。