Sigasi's Blog

Benefits of extracting documentation from software code

Software with good documentation is far more valuable than software without.
Software that needs to be reliable will be subject to a code review. Good documentation makes the review go more smoothly, and makes it more likely that the review will accomplish its intended purpose.

To "to" or to "downto"... Ranges in VHDL

Most VHDL designers write 'something downto something' in their code all the time. But what does this downto actually mean. And what is the difference with to?

The keywords downto and to specify the direction of ranges in VHDL. downto is descending (going down); to is ascending (going up).

Ranges in Arrays

When used in arrays, downto corresponds to little endian. This means that the least significant bit is stored at the lowest position.

Eclipse Marker Manager

Did you ever want to suppress warnings in Eclipse? For Java, there is the @SuppressWarnings directive, but what to do for other programming languages?

Sigasi is planning a new Eclipse plugin, called the Eclipse Marker Manager, that helps you deal with Problem Markers (warnings and errors).

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

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.

Why you need good documentation for your VHDL and Verilog code

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.