On-the-fly Documentation in Sigasi Visual HDL

The Sigasi documentation generator makes the documentation process more manageable by automatically extracting information from your HDL source files. The biggest advantage is that there is only one single source for both your design and your documentation.

The Sigasi documentation generator has the following advantages:

• No special coding requirements: the plain comments in your code are extracted for the documentation; no need for special annotations. Sigasi uses the same comment association as the hover provider. So, to document a port, you append a comment to a port declaration. To document an architecture, you put the comment just on top of the architecture.
• All documentation processing is done in Sigasi. So you do not need to install extra tools.
• Fully hyperlinked. If you export the documentation, you get a fully hyperlinked document.
• Live preview. You can see what the documentation will look like while you type your code and comments.

In this 2 minutes demo you’ll get the basics. Feel free to get in touch with us for more info or watch our other shorts serie.

Built for engineers and agents

AI can generate code quickly, but understanding that code is what makes it usable. Sigasi derives structured, project-aware documentation directly from the design, ensuring consistency and traceability. In AI-assisted workflows, documentation is no longer optional—it’s how engineers validate intent. Sigasi keeps that documentation aligned with reality.

Watch our webinar on AI

Interested in learning more on documentation with Sigasi in an AI enhanced world? Then watch our AI in chip design webinar in which we cover how Sigasi Visual HDL supports engineers that use AI in Cursor to create e.g. the documentation for a UART receiver. Sigasi does the deterministic heavy lifting and surfaces the hard-to-find issues created by AI on-the-spot. Engineers stay in control of the final decisions. The only tool that reviews HDL in real-time everywhere you work.

Try Documentation in Sigasi!

Request a free trial of our flagship Sigasi Visual HDL and discover how much time you safe when your documentation is always up-to-date and in line with your code both in VS Code, Cursor as in Antigravity. We gladly give you a free demo on top to get you started!

MY TRIAL