IP documentation standards and templates for HLS IP reference documents — port tables, resource utilization, performance metrics, integration guides, and changelog conventions
docs/<ip_name>/
├── README.md # Complete IP reference document
├── integration_guide.md # Step-by-step integration into Vivado
└── changelog.md # Version history with metrics
## for major sections, ### for subsections)10 ns, 256 cycles, 100 MHz3.14 with 2.718281845.2%Each port must specify:
Always provide:
Follow Keep a Changelog format:
Added — new features or filesChanged — modifications to existing functionalityFixed — bug fixesOptimized — performance improvements (include before/after numbers)Removed — deleted features or deprecated itemsAlways include synthesis metrics with each version entry.