3 ms·
From a literary perspective, technical writing is like any other genre. Good technical writers are deeply read of the canon, it's structures, and idioms. They u
by brudgers 9y ago
From a literary perspective, technical writing is like any other genre. Good technical writers are deeply read of the canon, it's structures, and idioms. They understand its audiences and their reasons for reading. Their work is ruthlessly edited. Their approach is serious. [1]
The hard part for a person without a technical background is the first. It's hard to empathize with a reader in an area of which the author has no experience. It's hard to know what to research without having a meaningful problem at hand. This can lead to the "designer problem." Absent an interest in the constraints of an important problem, designers will invent interesting problems by adding orthogonal constraints and elevate them to importance.[2]
Creative solutions to technical problems (or technical documentations problems) are only solutions if they solve important problems for other people.
Good luck.
[1] For CS, this suggests grappling with the likes of Knuth, Ableson and Sussman, McConnel, etc.
[2] This suggests research might include trying to learn to program for the same reasons anthropologists might try to learn the craft of an indigenous culture.