Student Jobs

Don't document the design; design the document

Here you find the details for the student job named "Don't document the design; design the document" in the company Easics NV.

Name: Don't document the design; design the document
Company: Easics NV

One could implement a state-of-the-art, super intelligent HW/SW design, but without any good documentation it's only a matter of time before it loses all value.

Ink is better than the best memory as the Chinese say.

At Easics, we completely agree, but our philosophy also relies greatly on efficient software techniques and revision control. We have our own software tools that automatically generate textual documentation output for e.g. register maps and test results. Using Git allows us to track their changes and compare different revisions. This method works perfectly for plain text files, which are the input of a document generator such as LaTeX, AsciiDoc, Markdown, …

However, the default file format used by Microsoft Word (.docx) has become a widespread de facto standard for office documents.

Easics has a tool written in C++ to generate Word documents and combine them. All the version control information is lost, however. The goal of this summer project is to expand the tool.

- Generate a document with change bars given 2 commits of source code.

- Generate a document with change bars given two documents differing only in generated content.

Target profiles:
  • Burgerlijk Ingenieur - Electronic Circuits and Systems
  • Burgerlijk Ingenieur - Computer Science Engineering
  • Industrial Engineering - Electronics
  • Computer Science
Required special knowledge:

Experience with C++ is required. Experience with command line git is a plus.

All info:

Application deadline is April 30th 2018.

Contact: Karin Janssens (management assistant)