Christofer Larsson – technical writer with background in physics and engineering (christofer@mathgallery.com)
Documentation is often a customer’s first contact with a product, and perhaps with the company altogether. Therefore, language and disposition are very important, as it gives a first impression of aspects of both the product and the organization. A good technical document should be
- easy to read for a broad audience with a minimum amount of searching or learning needed
- be of practical use, enriched with illustrations (photos, screenshots, diagrams, flow charts etc.)
- be structured to facilitate finding answers to questions and guide the reader to relevant sections or references
Any documentation should have a project manager, or document owner, with responsibility for
- design of the publication, including layout and illustrations
- degree of coverage, that is, that all relevant procedures are documented
- content verification, including testing of a product in accordance with the document
Illustrations
Illustrations should normally constitute a substantial part of the document. These should be meaningful and relevant to the topic. A number of frameworks or utilities can be used to create figures, such as UML (the class diagram) and LaTeX/Tikz (the mind map)
Publications and Samples
This notice board contains some links to some written material – both published and unpublished – on various topics.
Two books, published in 2014 and 2018, discuss engineering topics in telecommunications. Design of Modern Communication Networks is a monograph on general engineering principles in telecommunications, with techniques in traffic theory, queueing theory and network programming.
As the title suggests, 5G Networks – Planning, Design and Optimization, is concerned with some methods from real-world 5G design projects, and covers topics such as network science, machine learning and combinatorial optimization.
A few papers have are also available, academic as well as popular scientific, either published or unpublished.
On Bounded Peaking in the Cheap Control Regulator (pdf), co-authored with Xiaoming Hu, presented at IFAC YAC’95 and published as a conference paper.
My thesis, part of my Master’s degree in Engineering Physics, consists of the material under the links below (slightly edited)
Preliminaries
The Concept of Zero Dynamics – a Brief Survey
Frequency Domain Conditions for $L^2$-Bounded Cheap Control Regulators
Geometric Interpretation of the Cheap Control Regulator
The General Case
Conclusion
References