Documentation on Sigasi

Develop an IDE for Hardware Design

Thu, 20 May 2021 00:00:00 +0000

Sigasi develops Sigasi Visual HDL, an Integrated Development Environment (IDE) for digital design in SystemVerilog, Verilog or VHDL. We build this IDE on top of VS Code using their extension API and the Language Server Protocol (LSP). We provide the digital designer with all the facilities that are typically reserved for software developers such as syntax checking, navigation, project management, refactoring, and autocompletion.

Convert HDL documentation to PDF or Word

Mon, 01 Dec 2025 00:00:00 +0000

Sigasi Visual HDL (SVH) can generate documentation from the HDL code and corresponding comments in your HDL project. The documentation is written in HTML, which offers more flexibility than other formats such as PDF. Generated HTML documentation can be viewed directly in a browser. In this article, we’ll also show that converting HTML to PDF is trivial. And finally, you can import HTML in Microsoft Word for further processing.

Documentation Generation in CI with Sigasi CLI

Wed, 24 Jan 2024 00:00:00 +0000

At the start of 2023, Sigasi introduced Sigasi CLI, the command line tool for HDL validation. It has very useful documentation generation capabilities, long a favorite feature design and engineering teams.

Documentation features for large designs in Sigasi Visual HDL

Mon, 09 Jan 2023 00:00:00 +0000

Great hardware projects share a common tendency… they often grow into something huge and become difficult to support with time. Dealing with code complexity becomes a never-ending exercise to keep the ability to extend, maintain, verify, and debug the design. Having up-to-date documentation is one of the very efficient methods that help to achieve control over the code complexity, get familiar with unknown design parts or externally provided components, and accelerate onboarding of new team members. Keeping the documentation itself coordinated with the project progress could become a huge maintenance burden. However, Sigasi already covered this demand with the feature of automatic documentation generation based on the source descriptions, as shown in “Generate VHDL documentation in Sigasi Studio”.

Customizing documentation from Sigasi Visual HDL: easier than you think

Wed, 01 Jun 2022 00:00:00 +0000

Almost a year ago, we’ve posted an article on advanced customization of the documentation generated by Sigasi Visual HDL (SVH). In the article, we’ve demonstrated the use of the Document Object Model (DOM) and Python to alter the HTML code of the generated documentation. The article contains a fully elaborated example, as well as some suggestions of other use cases that the DOM could handle.

Customize documentation from Sigasi Visual HDL using the Document Object Model

Mon, 05 Jul 2021 00:00:00 +0000

This article discusses how documentation, generated by Sigasi Visual HDL (SVH), can be thoroughly customized to your needs.

In an earlier article, we have explained why HDL projects benefit from good documentation, and how SVH can extract HTML documentation from your HDL code and comments. The extracted documentation is written as a single, fully hyperlinked HTML file. Graphics such as state machine and block diagrams can be either embedded in the HTML file, or written as separate graphics (.svg) files.

Generate documentation in Sigasi Visual HDL

Tue, 22 Jun 2021 00:00:00 +0000

This article discusses documentation of Hardware Description Language (HDL) code, and how Sigasi Visual HDL (SVH) can help with that. Designers (and their managers) generally agree that well documented code is important. In practice, actually documenting code, documenting code well, and keeping documentation up to date doesn’t always happen. The excuse is often time, as in, we didn’t want to spend extra time or we didn’t even have time to write documentation (but a few months later we spent much more time tracking that one bug while reverse engineering our own code…). So before getting into the how of documentation, we’ll first revisit why good documentation is important.

How much time is spent on writing documentation versus developing RTL code?

Wed, 27 Nov 2013 00:00:00 +0000

Estimation of time for technical documentation and software development

Estimating software development schedules is a skill. The programmer who is going to do the work can figure out what steps they will need to take to implement that feature. And only the programmer can estimate how long each one will take. The nature of software development is that things which seem simple are often surprisingly complicated when we think about all the details. Attempting to estimate a feature before we’ve figured out how the feature is going to work, in detail, can’t possibly work, even if we multiply our best guess by three, because our “best guess” is based on very little in the way of facts. One of the most painful questions that developers are faced with is estimation and justification of time required for technical documentation development. Documentation developers need a methodology to provide a more or less precise and, most importantly, well-grounded estimation of documentation development time, already at the problem definition stage.

Why you need good documentation for your VHDL and Verilog code

Sun, 10 Nov 2013 00:00:00 +0000

In this blog series, guest blogger Smrita talks about the need for documentation for complex RTL designs.

In engineering, technical documentation refers to any type of documentation that describes handling, functionality and architecture of a technical product or a product under development or use. The intended recipient for product technical documentation is both the (proficient) end user as well as the administrator, service or maintenance technician. In contrast to a mere “cookbook” manual, technical documentation aims at providing enough information for a user to understand inner and outer dependencies of the product at hand. The technical documentation is intended to help the maintainers of the system (the people who need to keep the system running smoothly, fix problems, etc.) The maintainers are usually technical people, who need to know exactly how the system works .

Modernize Browser Integration

Mon, 01 Jan 0001 00:00:00 +0000

Modernize our diagram and documentation rendering stack by replacing Equo Chromium Browser with Chromium Embedded Framework.

Sigasi Project Evangelist

Mon, 01 Jan 0001 00:00:00 +0000

Contribute a project.sigasi description to open source hardware design projects

WaveDrom Documentation Generation

Mon, 01 Jan 0001 00:00:00 +0000

WaveDrom is an application to draw waveform diagrams from a textual format called WaveJSON. Help us parse this format from code comments to generate documentation, including diagrams, and assist the user with autocompletion and validation while writing them.