Verilog IP集成文档汇编
输入硬件IP名称,汇总模块文档、顶层端口和连接关系,生成包含架构图与接入示例的完整集成文档。
功能与用途
适用于将分散的Verilog模块说明整理成面向硬件集成人员的一份IP文档。提供IP名称及项目文件后,会梳理子模块层级,汇总模块用途、顶层端口、模块间接口、参数及运行约束,输出包含架构图和实例化示例的Markdown文件。发现缺失的模块文档时,需调用vexplain从源码补齐;已有综合报告时,还会收录资源占用、时序和功耗数据。使用前需准备顶层Verilog文件,并按项目约定存放模块资料。
适用场景
- IP交付资料汇编:将多个子模块的说明汇成一份IP集成文档,供接收团队查阅端口、架构和使用约束。
- 系统接入说明编写:从顶层端口与模块连接关系整理接口表、参数说明和完整实例化示例。
- 旧项目文档补全:检查子模块文档缺口,调用vexplain补齐缺失说明后生成统一的IP文档。
- 综合结果归档:将已有综合报告中的资源占用、时序、功耗与警告汇入IP文档,便于交付查阅。
适用人群
- RTL设计工程师
- 芯片IP集成工程师
- FPGA开发工程师
- 硬件技术文档维护人员
使用步骤
- 提供IP名称,确认顶层Verilog文件位置。
- 梳理模块层级,收集项目与复用库的模块文档。
- 检查文档缺口,必要时调用vexplain补齐。
- 汇总架构、接口、接入示例及已有综合结果。
- 查看生成的doc/<ip_name>.md,核对集成信息。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 进阶
- 版本
- 1800fd1
- 最近更新
- 2026-11-11
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Aggregate all per-module documentation into a single comprehensive IP document
使用前准备
- 在Claude Code中安装vdoc,并提供可读取的Verilog项目。
- 准备rtl/<ip_name>_top.v,以及doc/或lib/下的模块文档。
- 提供共享层级提取规则;模块文档缺失时需有对应RTL源码及可用的vexplain。
- 如需收录综合结果,准备synth/<ip_name>/synth_report.md。