批绘 文档 批绘(Pihui)用户指南与开发者文档。独立产品:设计稿批注,不是印迹、不是图说。公开身份 pihui;简码仅 [pihui] / [pihui_dashboard]。书架:莫蒂奇。 用户指南 用户指南 批绘介绍 批绘介绍 批绘(Pihui)是莫蒂奇的设计稿批注工具:把设计稿上传到批绘,在画面上直接标出问题、写意见并跟踪处理状态。 它不是: 印迹:浏览器内的视觉盖章工具 图说:教程截图与圈注工具 薇晓朵主站的 WordPress 子目录 公开地址: https://pihui.modiqi.com/。Slogan:把反馈画在点上。 打开分享短链 打开分享短链 项目经理会发你一条批绘链接(mockup 审阅页或短链)。浏览器打开即可,一般不需要注册批绘账号。 建议: 用桌面浏览器(Chrome / Edge / Safari 均可)。 首次进入若提示姓名、邮箱,只用于评论署名,不会自动变成站内注册账号。 链接请勿转发到公开群;作废后旧链接会失效。 若页面打不开或跳到无关站点,把完整 URL 发回项目经理,不要自行改域名。 评论、解决与附件 评论、解决与附件 评论 在画布上点击需要反馈的位置。 写下问题或修改建议;尽量具体(位置、期望效果)。 提交后其他人可回复同一条线程。 解决 / 确认 线程可标为已解决或需再改。以项目约定为准:有的项目要客户点「确认」,有的只由设计方收口。 附件 支持在评论里上传图片等附件(若项目开启)。上传成功后应能直接打开附件 URL。若失败,请截图报错与浏览器控制台网络状态发给项目经理。 版本与缩放 版本与缩放 版本图例 同一画布可能有多版稿件,界面会标清例如: v1 原图 — 客户原稿或第一版 v2 方案 A — 后续修改方案(名称以项目实际为准) 切换版本时确认自己在评哪一版,避免把意见打到旧图上。 缩放 首次进入会使用适合屏幕的默认缩放(以看清全图为主)。可用缩放控件放大细节;看不清文字时优先放大,而不是凭模糊截图猜。 访客身份说明 访客身份说明 批绘允许在分享链接下以访客身份评论(项目开启访客时)。 请注意: 填写的姓名 / 邮箱用于评论署名与通知,默认不会因此自动创建可登录的站内账号。 需要长期登录、收到邮件汇总的客户,由项目经理另行发放个人登录链,不是打开短链就注册。 不要在评论里粘贴密码、密钥、内部工单号或未公开的商务条款。 中文客户项目可由项目经理打开中文界面,不影响其他英文项目。 常见问题 常见问题 Q:批绘和印迹有什么区别? A:批绘管设计稿批注;印迹管浏览器内的视觉盖章。二者域名与产品都独立。也不是图说(教程截图圈注)。 Q:我需要安装插件吗? A:审阅方一般只要浏览器打开链接。被批注的网站若要嵌网站批注条,由技术方配置,不在本指南范围。 Q:短链能不能长期挂着? A:项目收尾后应作废或关闭访客。需要回看时由项目经理再开。 Q:界面语言不对? A:中文项目访客主路径应为简体中文。若大量英文挡路,把页面截图发给项目经理。 Q:WordPress 简码怎么用? A:在批绘枢纽站(需登录)可用 [pihui id="项目ID"] 展示单个项目, [pihui_dashboard] 展示个人仪表盘。没有旧版第三方简码名。属性说明见开发者文档「嵌入、简码与 CLI」。 Q:发客户链前要确认什么? A:图是否齐全、访客是否可评、语言是否合适;由项目经理确认可发后再发,不要把内部检查命令写进客户邮件。 在枢纽站用简码(成员) 在枢纽站用简码(成员) 批绘枢纽站支持把项目入口嵌进普通页面(需已登录)。审阅客户一般不用简码,打开分享链接即可。 单个项目 [pihui id="项目数字ID" columns="3" per_page="9"] id:后台项目 ID(必填) columns:列数,默认 3 per_page:每页条数,默认 9 个人仪表盘 [pihui_dashboard] 可选: columns、 mockups、 websites、 activity、 filter、 per_page。 未登录时页面会提示登录,不会露出其他成员的项目。 开发者文档 开发者文档 批绘开发者文档 批绘开发者文档 面向二次开发与站点集成。批绘是独立产品:公开面标识一律 pihui;内部 PHP 符号可仍见历史前缀。上游 Project Huddle / SureFeedback 只作参考,不合并。 公开枢纽: https://pihui.modiqi.com/。运维主机、备份与边缘细节见内部系统卡,不在本公开文档展开。 架构总览 架构总览 层 说明 插件 pihui WordPress 插件,引导文件 pihui.php,主类 Pihui 枢纽 pihui-hub 同站枢纽插件:REST 范围守卫、嵌入、身份 nonce、WP-CLI wp pihui 枢纽站 独立 WordPress(公开域 pihui.modiqi.com),表前缀沿用历史 ph_ 边缘 CDN 回源时 Host 须为枢纽站域名,禁止落到无关默认站 公开身份: Text domain / script translations: pihui REST: /wp-json/pihui/v2/ CPT: pihui-project、 pihui-image、 pihui-version、 pihui-thread、 pihui-website、 pihui-webpage、 pihui-web-thread 简码: [pihui]、 [pihui_dashboard](仅此二者) 资源句柄与 dist: pihui.js、 pihui-admin.css 等 简码残留验收 产品仓内 add_shortcode 不得再注册 project_huddle、 project-huddle 或旧公开简码名。验收检索 add_shortcode;命中非 pihui / pihui_dashboard 即 FAIL。 REST 与 CPT REST 与 CPT REST 命名空间: pihui/v2。集合路由受枢纽作用域守卫约束:带项目分享令牌时不得夹带他项目资源;无令牌时按策略拒绝或仅允许白名单最小集(例如已嵌入的网站批注场景)。 公开探针: GET https://pihui.modiqi.com/wp-json/pihui/v2/ 期望 200。跨项目夹带应 403。 CPT 对照(迁移后) 历史名 现行公开名 ph-project pihui-project project_image pihui-image ph_version pihui-version ph_comment_location pihui-thread ph-website pihui-website ph-webpage pihui-webpage phw_comment_loc pihui-web-thread 能力类型随 CPT 名称变化;角色能力以插件角色类现行实现为准。 嵌入、简码与 CLI 嵌入、简码与 CLI 网站嵌入 枢纽为网站项目提供 /e/{id}.js 一类加载器。客户站点需放行脚本源与 CSP。印迹等站只嵌脚本、不改盖章逻辑。 Website 与 Mockup 是两类项目:网站批注走 pihui-website;设计稿批注走 pihui-project。 前台简码(需登录) 在枢纽站任意页面/文章中写入: 简码 作用 常用属性 [pihui id="123"] 单个项目图集入口 id(必填, pihui-project 或网站项目 ID)、 columns、 per_page [pihui_dashboard] 当前用户的项目仪表盘 columns、 mockups、 websites、 activity、 filter、 per_page 未登录时简码区应显示登录表单(不要空白)。旧名 [project_huddle] 等已移除。 示例: [pihui id="123" columns="3" per_page="9"] [pihui_dashboard columns="3" activity="true"] 运营发链原则 发客户短链前做发链检查(图是否齐全、访客是否可评、语言是否合适)。具体运营 CLI 与包装脚本属内部工具,不在公开文档展开。分享令牌与客户登录链走私密通道;密钥留在枢纽,不进公开文档或工单正文。显式为客户建站内账号仅限运营流程,不得由访客短链自助开户。 访客与安全策略 访客与安全策略 REST 作用域:项目分享令牌不得读取他项目集合(枢纽 PH_REST_Scope,命名空间 pihui/v2)。 访客评论:允许姓名邮箱署名;默认不因此建站内账号。访客自助开户接口返回 pihui_guest_no_account(403),除非具备建用户能力或显式 filter。 匿名评论:项目开启访客时,允许 REST 匿名评论(姓名邮箱)。 项目中文:可为单个项目打开中文访客界面,不必改全站语言。 签名登录:特权角色禁止靠客户站签名自动登录。 身份 nonce:个人登录链宜用一次性 nonce,避免身份长期出现在 URL / 访问日志。 发链前:运营完成发链检查后再发;评论导出默认不含内部备注标记。 部署与红线(公开摘要) 部署与红线(公开摘要) 主机路径、备份目录、边缘 IP、工位机名等运维细节不在本文。内部真源见内部系统卡与 runbook,勿抄进酷可公开书。 原则 插件变更经产品仓发布后再上枢纽站;运行时需带齐 vendor/ 与前端 dist/。 上线前保留可回滚的插件快照;回滚后确认 REST 根命名空间 pihui/v2 与公网首页为批绘壳,不是无关注册页。 枢纽站独立于莫蒂奇主站与薇晓朵多站点;不要把批绘并进其他品牌站的表前缀或文档根。 发客户短链前走发链检查(运营 CLI / 清单);分享令牌轮换走私密通道,不写进文档或工单正文。 文档站(酷可)与枢纽插件分开维护;改书不要误动其他书架。 红线 回源 Host 必须打到批绘枢纽,禁止落到默认站 / 注册页。 不把 GPL 产品改成 MIT;上游参考仓不当产品仓改。 公开文档只写产品能力与集成约定,不写内网别名、绝对路径、备份样例或提交哈希。