Technical manual: architecture of an embedded framework

This technical manual is an architecture document that describes a software framework of an embedded system. It is a high level document, so it contains the necessary diagrams and high level descriptions.

The documents shown below are a number of unrelated sections taken from the framework architecture documentation. They are not one continuous part of the document!

Because of the proprietary nature of this document, the pages have been converted into graphics and have been anonymised.

 

Using OpenCV 3 from #golang

Go is a great language. But when you need to use OpenCV, you’re stuck with a dilemma. Do you use OpenCV 2.4, which is aging but has C bindings so it’s usable from Go? Or do you use OpenCV 3, which is up-to-date with the latest algorithms and optimisations but only has a C++ interface? If you need OpenCV 3, you cannot call it directly from Go because Go doesn’t support calls to C++ code.

This blog article describes how to use OpenCV from Go anyway, using a C callable wrapper function. All source code is provided in the article.

 

RFP/lastenboek/cahier des charges: call center

This RFP describes a telephony solution for a call center. The client had strict demands on how he wanted to use the telephony system. He outlined in detail how the system had to route the incoming calls to the agents. The RFP also described the way an agent would use the system. For the supervisor, a dashboard gave an overview of the ongoing activity.

The document gives a general overview of the solution. Then, it answers each of the feature requests one by one, describing how the proposed solution conforms to the request.

An RFP (lastenboek / cahier des charges) is frequently technical in nature because the customer has very specific demands. A technical writer can translate the technical answers into a compelling story and redact the source texts from technical and sales people.

Because of the proprietary nature of this document, the pages have been converted into graphics and have been anonymised.

RFP call center RFP call center RFP call center

Leaflet: commitment to green IT

This leaflet was part of an answer to an RFP for a telephony system. One of the requirements was a commitment to green IT. The leaflet describes this commitment, both in words as well as in technical statements. It describes the power advantages of the proposed solution and gives wattages of each component.

Marketing leaflets are usually not the focus of a technical writer, but answers to RFPs are frequently technical in nature. That makes the technical writer the right person to write and redact these documents.  He can process the input of both the technical and the sales teams, bundling it all into a neatly finished package.

Because of the proprietary nature of this document, the pages have been converted into graphics and have been anonymised.

Leaflet green IT Leaflet green IT Leaflet green IT

Presentation: architecture of an RTOS

This presentation gives a high-level architectural overview of an RTOS when it’s used in a multicore environment. It was used by sales people, but because of the nature of the product, it contains highly technical content. The slides below discuss the development process using the RTOS, typical use cases and the architecture.

In technical environments, sales presentations like the one below are common tasks for a technical writer. Our expertise with storytelling and conveying clear messages improves a presentation, making it easier to understand.

Because of the proprietary nature of this document, the slides have been converted into graphics and have been anonymised.

Presentation: RTOS architecture Presentation: RTOS architecture Presentation: RTOS architecture

White paper: technology of a software tool

This white paper outlines the technological base of a software development tool. It describes the traditional, manual approach to the problem that the tool solves. Because this approach has its disadvantages, the white paper also looks at another existing solution before outlining the advantages of the new tool’s approach. It also gives a number of case studies that are described on the architectural level.

Because of the proprietary nature of this document, the pages have been converted into graphics and have been anonymised.

page of a technological white paper page of a technological white paper

Contact us for more information or for a quote:

Article: overview of a software tool

The following article advocates the use of a software development tool. It outlines the technological context in which the users of the tool typically work. From that, it derives the benefits of the tool and concludes that the tool is, indeed, a great addition to a software developer’s toolbox.

Because of the proprietary nature of this document, the pages have been converted into graphics and have been anonymised.

article about a software development tool

Contact us for more information or for a quote:

IWT funding request: software development tool

Funding requests are frequently technical in nature, because they need to describe accurately for which technology the funding will be used. This is a great task for a technical writer. While the style of a funding request is very formal, which makes the writer’s job a bit more difficult, the satisfaction is huge when the funding is granted.

The following pages are excerpts from a funding request to IWT, the Flemish government agency for innovation through science and technology. The pages below are typical for a funding request for such an agency: a description of the technology, a division into work packages (WP) and a societal base for the use of the technology.

Because of the proprietary nature of this document, the pages have been converted into graphics and have been anonymised.

Funding request page Funding request page Funding request page

Contact us for more information or for a quote:

Technical sales presentation

Technical sales are a domain where a good technical writer can shine. He can work on the technical parts of a sales presentation as well as other collateral. Presentations have their own challenges, as they should condense information into a good overview. At the same time, they should not distract the listener from the presenter. That’s why some slides are sparse, allowing the presenter to explain what is shown.

Because it’s a sales presentation, it contains a number of technical remarks from a customer testimonial.

techwriter sales presentation techwriter sales presentation

Contact us for more information or for a quote: