城市出行天气组件功能需求文档

所属分类:天气/空气质量
产品案例页:https://engineering.gugudata.com/products/weather/travel-weather-widget/
产品定位与截图范围
城市出行天气组件属于天气/空气质量场景,面向网站和应用嵌入的出行天气组件管理台,截图重点是组件列表、组件配置、样式设置、数据源配置、权限设置、预览、组件代码、组件库、数据面板和发布管理。这篇 PRD 只描述当前截图对应产品,页面目标是让业务方先理解这套界面的使用价值,再通过下方关联接口判断数据能力是否覆盖自己的项目。
产品需要把截图中的信息组织成可交付的软件需求:导航区说明用户能进入哪些业务模块,左侧区域说明对象如何被筛选和管理,中间区域说明核心处理任务如何完成,右侧区域说明结果、配置、统计或详情如何被核对。用户阅读后应能判断该系统适合解决什么问题、日常如何操作、输出什么结果、验收时看哪些指标。
目标用户与业务场景
主要用户包括:
- 出行产品运营
- 网站管理员
- 前端集成人员
- 城市服务运营
- API 管理员
这些用户通常不是为了体验单点工具,而是为了在真实业务中持续处理数据、资料或任务。系统需要支持从对象导入、筛选定位、任务执行、结果核对到导出沉淀的完整流程。截图中的布局应被理解为高频工作台:左侧负责范围和对象,中间负责操作和主结果,右侧负责配置、质量、详情或辅助分析。每个区域都应服务于减少人工查找、重复录入和跨工具切换。
截图可见信息组织
顶部导航和一级模块包括:
- 组件管理
- 数据监控
- 模板管理
- 发布管理
- 使用统计
- API 管理
- 系统设置
左侧区域需求:左侧组件列表按城市组件和路线组件展示组件名称、城市、状态和更新时间,支持分组管理国内城市、热门旅游城市和国际城市。
主工作区需求:中间编辑区展示当前组件名称、状态、ID 和版本,配置项包括城市、默认定位、单位制、显示模块、出行指数、刷新设置和其他设置。预览区展示桌面端天气组件,包含当前天气、空气质量、小时预报、出行指数、日出日落、天气预警和未来趋势。
右侧与辅助区需求:右侧数据面板展示实时天气、空气质量、天气预警和数据更新状态;组件代码区提供可复制到页面的嵌入代码;顶部支持刷新数据、数据配置检查和发布组件。
截图中的页面需要保持信息密度,但不能牺牲可读性。列表、筛选器、标签页、统计卡片、图表和操作按钮都应围绕当前业务对象展开。用户切换对象后,中间主内容和右侧详情必须同步,避免出现列表选中项、预览内容和统计结果不一致的情况。
核心功能需求
对象管理:系统应提供清晰的对象列表或对象树,支持搜索、筛选、分组、状态区分和批量操作。对象行需要展示足够的业务字段,让用户不进入详情也能判断当前对象是否值得处理。
主任务处理:系统应把截图中的高频动作放在主操作区,减少用户在菜单中查找功能的时间。对于需要批量处理的场景,页面要展示任务状态、进度、成功失败数量和可恢复操作;对于查询分析类场景,页面要展示筛选条件、结果表和关键指标。
结果核对:右侧或下方结果区应展示用户最关心的结果摘要、质量、详情、来源或导出入口。结果需要能被复制、下载、导出、继续分析或进入下一步流程。若存在失败、异常或低质量结果,应以业务语言说明原因,并提供重试、修改、忽略或查看详情。
记录沉淀:系统应保留任务记录、操作记录、历史结果或最近使用记录。用户需要能够回溯某一批数据的处理时间、处理人、输入对象、输出结果和当前状态,便于团队协作和交付复盘。
配置复用:当截图中出现模板、规则、字段、样式、系统设置或数据源配置时,产品应允许团队沉淀常用方案。配置项应使用业务名称描述,避免让用户理解无关参数。
主要操作流程
- 新建或导入城市天气组件
- 选择城市、定位方式和显示模块
- 配置出行指数、刷新频率和数据来源展示
- 在预览区核对桌面端效果
- 复制组件代码或发布组件
流程设计要保证用户能随时知道自己处于哪一步。对于导入类流程,用户需要先看到导入对象是否正确;对于分析类流程,用户需要确认筛选条件和数据范围;对于发布或导出类流程,用户需要确认结果质量和输出格式。任何关键操作都应在页面上有明确反馈,而不是只依赖短暂提示。
数据与结果展示
该系统需要重点输出:
- 天气组件预览
- 嵌入代码
- 实时天气数据
- 空气质量数据
- 天气预警
- 组件发布状态
- 使用统计
结果展示应遵循三层结构。第一层是概览指标,用于快速判断整体状态;第二层是明细列表或图表,用于定位具体对象;第三层是详情、记录或来源,用于核对结果可信度。截图中的表格、趋势图、地图、预览器、富文本区、卡片和环图都应作为业务结果的一部分,而不是装饰性元素。
对于长列表,分页、排序、搜索和筛选必须稳定可用。对于图表和地图,颜色、图例、单位、更新时间和数据来源要清晰。对于文件或报告类结果,下载、导出、复制和查看详情需要保持一致的位置和命名。对于质量类结果,分数、错误数、重复率、有效率、置信度和风险等级需要能让用户直接采取下一步动作。
接口调用蓝图
接口调用蓝图只列出当前案例的核心接口。所有请求地址均使用生产 API 域名,接口文档地址指向咕咕数据公开详情页。表格中的 * 表示必填参数;appkey 只代表调用方自己的访问凭证占位,不展示真实值。
| 业务步骤 | 接口名称 | 接口文档 | 请求地址 | 关键入参 | 关键出参 | 传参关系 |
|---|---|---|---|---|---|---|
| 天气预报 | 全国天气预报信息 | weatherinfo |
GET https://api.gugudata.com/weather/weatherinfo |
appkey* (query)、code* (query)、days (query) |
天气、温度、风力、日期 | 行政区代码写入 code,days 控制预报天数。 |
| 空气质量 | 全国城市实时空气质量指数 | airquality |
GET https://api.gugudata.com/Weather/AirQuality |
appkey* (query)、city* (query) |
AQI、PM2.5、首要污染物 | 城市名称写入 city,结果进入空气质量卡片。 |
| 农历节气 | 农历与二十四节气 | lunarcalendar |
GET https://api.gugudata.com/weather/lunarcalendar |
appkey* (query)、date* (query) |
农历日期、节气信息 | 日期写入 date,用于日历说明。 |
| 日出日落 | 日出与日落时间 | sunrisesunset |
GET https://api.gugudata.com/weather/sunriseandsunset |
appkey* (query)、city* (query)、date* (query) |
日出、日落和天文时间 | 城市与日期写入 city、date,结果进入时间模块。 |
参数流转说明
组件入口通常只有城市和日期。城市先映射到天气接口需要的 code,同时保留城市名称给空气质量和日出日落;当前日期传给农历和日出日落接口。所有结果需要压缩为摘要视图,展开后再展示更多字段。
用户输入的原始对象需要和每一步接口结果保持明确对应关系。页面应保留原始输入、当前处理参数和接口输出结果之间的联系,让用户可以从任一结果回到来源对象。例如用户修改关键词、日期、代码、文件、城市或号码后,所有依赖该参数的结果都需要重新标识为待刷新或重新查询,避免旧结果和新条件混在一起。
不同接口之间传参时,只传递公开接口需要的业务字段。文件类场景传递文件、文件地址或识别文本;数据查询类场景传递代码、日期、区域、关键词或分页条件;文本类场景传递正文、目标语言、对比文本或处理风格;号码类场景传递原始号码、标准号码和国家区号。接口返回结果进入页面后,需要转换为业务人员能理解的字段名称和操作入口。
如果用户批量处理多个对象,系统应把每个对象的参数和结果分开保存到列表行或任务项中。批量任务可以并行展示进度,但用户在页面上看到的仍应是每条业务对象的输入、状态和输出,不能只显示一个模糊的整体结果。失败项需要保留原始输入和失败步骤,方便用户修正参数后重新提交。
相关接口能力范围
当前分类下完整相关接口包括:全国城市实时空气质量指数、全国天气预报信息、农历与二十四节气、日出与日落时间。这些接口仍由页面下方“相关数据接口”区域统一展示,接口名称、简介、能力标签和文档入口保持完整。PRD 正文中的调用蓝图用于说明核心链路,不替代接口详情页,也不覆盖每个接口的全部参数、示例和响应字段。
用户阅读本案例时,应先理解 城市出行天气组件 的业务流程,再根据接口调用蓝图判断是否满足自己的集成场景。如果需要扩展到同分类下其他能力,可以继续点击下方接口文档查看完整说明。这样既能保证 PRD 可读,又能保留完整接口入口。
体验要求与验收标准
页面渲染顺序应保持为产品截图、功能需求文档、相关数据接口。当前 case 有独立 PRD 时显示文档区,切换到任意其他 case 时显示该 case 自己的文档,不能出现所有 case 共用同一篇总文档的情况。文档标题统一为“功能需求文档”,正文采用适合长文阅读的排版,段落宽度、行距、标题层级和列表样式要与工程站点风格一致。
桌面端需要保留左侧导航固定能力,用户阅读长文和接口列表时仍能切换案例。移动端需要单列展示,图片、文档、接口列表不能互相遮挡,表格或长内容不能造成页面整体横向溢出。没有配置或加载失败的文档不应显示空白模块;但本次目标是所有 case 都有对应文档,因此最终验收时每个 case 都应能读取到 Markdown 内容。
验收时需要逐个检查:case 标题是否与截图一致,截图是否正常显示,功能需求文档是否是当前 case 的独立内容,相关接口是否仍按行业分类完整显示,接口数量是否与侧边分类数量一致,点击接口文档是否进入咕咕数据接口详情页。只有这些要求都满足,才能认为该 case 的 PRD 渲染完成。
截图功能验收清单
验收人员需要按照截图从左到右、从上到下检查页面,而不是只看主标题是否存在。顶部导航应能说明产品的主要业务模块;左侧列表、树形结构或批次区域应能说明当前管理对象;中间工作区应能完成主要查询、处理、编辑、预览、分析或生成动作;右侧详情、统计、配置或质量区域应能回答用户为什么可以信任当前结果。若某个区域只显示静态占位、字段与截图语义不一致、切换对象后详情没有同步、导出入口无法体现当前业务结果,都应视为未满足该 case 的 PRD 要求。
文档展示也要按独立 case 验收。进入该案例路由后,功能需求文档中的产品名称、业务场景、导航模块、核心流程和输出结果都必须与当前截图一致;切换到相邻案例后,文档内容必须随 case 变化,不能继续显示上一案例的文字。相关接口区域需要保持在文档之后完整显示,作为从产品案例进入接口详情的能力入口。
关于 GuGuData Engineering 产品案例
更多产品案例请访问 GuGuData Engineering 产品案例。
GuGuData Engineering 产品案例页展示基于咕咕数据接口能力构建的数据接入、业务流程和产品原型,帮助团队从真实业务场景出发,快速评估接口组合、调用方式和落地价值。
–EOF–
转载须以超链接形式标明文章原始出处和作者信息
