diff --git a/knowledge/repos/vllm-omni/docs/_index.md b/knowledge/repos/vllm-omni/docs/_index.md index 4c2c6363a..d1f2c6720 100644 --- a/knowledge/repos/vllm-omni/docs/_index.md +++ b/knowledge/repos/vllm-omni/docs/_index.md @@ -1,7 +1,7 @@ --- title: "vLLM-Omni 文档" created: 2026-07-10 -updated: 2026-09-05 +updated: 2026-09-07 type: index tags: [vllm-omni, docs] sources: ["PR #5715", "PR #6029", "PR #6858", .claude/skills/readme.md, README.md, docs/configuration/README.md, docs/contributing/README.md, docs/getting_started/installation/README.md, docs/getting_started/installation/gpu/cuda.inc.md, docs/getting_started/installation/npu/npu.inc.md] @@ -22,6 +22,8 @@ sources: ["PR #5715", "PR #6029", "PR #6858", .claude/skills/readme.md, README.m | 遇到什么 | 查看哪里 | |---|---| | 判断 RFC 是否仍在进行 | [RFC status](rfcs/_index.md) | +| 查找仓库专有的文档与规划模板 | [documentation guides](guides/_index.md) | +| 编写或评审 RAT 需求文档 | [RAT requirement template](guides/rat-requirement-template.md) | | 找上游官方设计文档与其知识树 owner | [design-doc map](design-doc-map.md) | | generated example URL/nav、supported-model recipe 与硬件证据 | [generation and support rules](generation-and-support-rules.md) | | contributor agent workflow、repository skill catalog 与信任边界 | [repository skill rules](repository-skills.md) | diff --git a/knowledge/repos/vllm-omni/docs/guides/_index.md b/knowledge/repos/vllm-omni/docs/guides/_index.md new file mode 100644 index 000000000..37df29a38 --- /dev/null +++ b/knowledge/repos/vllm-omni/docs/guides/_index.md @@ -0,0 +1,25 @@ +--- +title: "vLLM-Omni 文档指南" +created: 2026-09-07 +updated: 2026-09-07 +type: index +tags: [vllm-omni, docs] +sources: [] +--- + +# vLLM-Omni 文档指南 + +## 什么时候查这里 + +- 编写 vLLM-Omni 仓库专有的文档、规划材料或评审模板。 + +## 不放什么 + +- 跨仓库通用的文档方法;先看 [通用文档知识](../../../../general/docs/_index.md)。 +- vLLM-Omni 的公开设计文档映射和生成规则;返回 [文档入口](../_index.md)。 + +## 目录内容 + +| 遇到什么 | 查看哪里 | +|---|---| +| 编写或评审 RAT 需求文档 | [RAT 需求文档模板](rat-requirement-template.md) | diff --git a/knowledge/repos/vllm-omni/docs/guides/rat-requirement-template.md b/knowledge/repos/vllm-omni/docs/guides/rat-requirement-template.md new file mode 100644 index 000000000..d3e669284 --- /dev/null +++ b/knowledge/repos/vllm-omni/docs/guides/rat-requirement-template.md @@ -0,0 +1,82 @@ +--- +title: "vLLM-Omni RAT 需求文档模板" +created: 2026-08-06 +updated: 2026-09-07 +type: guide +tags: [vllm-omni, docs, planning] +sources: ["https://github.com/JiusiServe/vllm-omni-project-manage/issues/66"] +--- + +# vLLM-Omni RAT 需求文档模板 + +**何时使用**:提交或评审 vLLM-Omni RAT 需求时,用本页确认需求背景、客户诉求、交付时间、工作量、规格约束和周边依赖均已明确。 + +本页归档自 [vllm-omni-project-manage issue #66](https://github.com/JiusiServe/vllm-omni-project-manage/issues/66)。下方保留原模板的字段和示例语义;使用时替换所有占位内容,并在评审完成后填写评审结论。 + +## 模板 + +````markdown +### 需求名称 + +(示例:【xxLHS】xx提供日志归档、监控指标采集功能,配合EI对接xx运维监控、计费管理) + +### 需求描述(格式化描述) + +【需求背景和价值】--Why + +1. 需求背景:(示例:xx组件部署在数据面,对于xx集群中无法自动恢复的故障需要上报告警信息,通知 Fabrics 的 SRE,通过人工干预的方式进行恢复); +2. 需求价值:(示例:支撑 LHS 1230 商用上线)。 + +【目标客户】--Who and Where + +(示例:xx EI - LakeHouse Service,xx贵阳 202 局点) + +【客户诉求】--What + +(示例: + +1. xx集群中无法自愈的故障,需要上报告警信息,通过人工干预方式恢复集群的运行; +2. xx SDK、runtime 打印的日志提供滚动压缩和老化删除能力,防止日志过大或过多,占用磁盘空间,导致集群无法正常工作; +3. DWS 中xx计算引擎需要获取xx集群中可用资源信息,用于决策启动 DN 函数实例 range 最大函数实例范围。) + +【交付时间】--When + +(示例:2024/12/30:乌兰一、贵阳 202、北京四、新加坡 Region 商用上线) + +【需求描述】--How and How many work + +(示例: + +1. AR1:xx集群中无法自愈的故障,需要上报告警信息;-1 人月 +2. AR2:用户函数日志支持滚动和 runtime 日志支持老化删除;-0.5 人月) + +【需求规格和约束】--How Much + +默认都涉及,若不涉及需单独说明。 + +1. 规格指标要求(包括但不限于性能、可靠性等): + (示例:支持的卡型号、模型、输入规格(图像大小张数、视频分辨率长度、文本输入长度、音频长度)、输出规格、并发支持、性能指标 SLO(RTF、TTFT、TPOT、吞吐)) +2. 约束(整个需求存在哪些约束条件): + (示例:无) + +【工作量】 + +(示例:1.5 人月) + +【需求定位】 + +(示例:商用) + +【周边依赖】 + +(示例:依赖 MindIE-SD xxx 版本 xxxx 特性) + +### 评审结论 + +(示例:vLLM-Omni 0.28 版本接纳该需求,1.5 人月工作量纳入项目人力管道) +```` + +## 相关知识 + +- 需要把需求继续收敛为开发前规格时,使用 [Canonical Mini Spec](../../../../general/planning/guides/mini-spec.md)。 +- 需要核验公开文档、支持声明或生成内容时,查看 [generation and support rules](../generation-and-support-rules.md)。