408
Views
24
Downloads
5
Crossref
N/A
WoS
3
Scopus
0
CSCD
The objective of this contribution is to consider guides to technical writing. Since the professional writes what he does and does what he writes, guides to how you execute the one relate to how you perform the other, so this article is about more than just writing. While there is need for idiosyncrasy and individualism, there are some rules. Documents must have an explicit purpose stated at the outset. By their nature, documents in the applied sciences and business address real-world problems, but elsewhere activity may be laissez faire for which the cost-effectiveness in yielding innovations is contestable. A hallmark of written science and technology is that every statement is capable of being tested and capable of being shown to be wrong, and that methods yield repeatable results. Caution should be observed in requiring authoritative referencing for every notion, partly because of the unsatisfying infinite regress in searching for ultimate sources, and partly to avoid squashing innovation. It is not only the content of messages that matters, but reliability too. Probability theory must be built into design to assure that strong inference can be drawn from outcomes. Research, business and infrastructure projects must substitute the frequent optimistic 'everything goes according to plan' (EGAP) with a more realistic 'most likely development' (MLD) and the risks of even that not happening. A cornerstone of science and technology is parsimony. No description, experiment, explanation, hypothesis, idea, instrument, machine, method, model, prediction, statement, technique, test or theory should be more elaborate than necessary to satisfy its purpose. Antifragility – the capacity to survive and benefit from shocks – must be designed into project and organizational structure and function by manipulating such factors as complexity and interdependency to evade failure in a turbulent and unpredictable world. The role of writing is to integrate these issues, and communicate them so that the stakeholders share a vision before, during and after the project.
The objective of this contribution is to consider guides to technical writing. Since the professional writes what he does and does what he writes, guides to how you execute the one relate to how you perform the other, so this article is about more than just writing. While there is need for idiosyncrasy and individualism, there are some rules. Documents must have an explicit purpose stated at the outset. By their nature, documents in the applied sciences and business address real-world problems, but elsewhere activity may be laissez faire for which the cost-effectiveness in yielding innovations is contestable. A hallmark of written science and technology is that every statement is capable of being tested and capable of being shown to be wrong, and that methods yield repeatable results. Caution should be observed in requiring authoritative referencing for every notion, partly because of the unsatisfying infinite regress in searching for ultimate sources, and partly to avoid squashing innovation. It is not only the content of messages that matters, but reliability too. Probability theory must be built into design to assure that strong inference can be drawn from outcomes. Research, business and infrastructure projects must substitute the frequent optimistic 'everything goes according to plan' (EGAP) with a more realistic 'most likely development' (MLD) and the risks of even that not happening. A cornerstone of science and technology is parsimony. No description, experiment, explanation, hypothesis, idea, instrument, machine, method, model, prediction, statement, technique, test or theory should be more elaborate than necessary to satisfy its purpose. Antifragility – the capacity to survive and benefit from shocks – must be designed into project and organizational structure and function by manipulating such factors as complexity and interdependency to evade failure in a turbulent and unpredictable world. The role of writing is to integrate these issues, and communicate them so that the stakeholders share a vision before, during and after the project.
Decker DJ, Riley SJ, Siemer WF (2012) Human Dimensions of Wildlife Management, 2nd edition. Johns Hopkins University Press, Baltimore, p 286
Ellery WN, Mentis MT (1992) How old are South Africa's grasslands? In: Furley PA, Proctor J, Ratter JA (ed) Nature and Dynamics of Forest-Savanna Boundaries. Chapman and Hall, London, pp 283–292
Feyerabend P (1975) Against Method. Humanities Press, London, p 336
Fleyvbjerg B, Bruzelius N, Rothengatter W (2003) Megaprojects and Risk. Cambridge University Press, Cambridge, p 207
Kahneman D (2011) hinking, Fast and Slow. Penguin, London, p 499
Lesmoir-Gordon N, Rood W, Edney R (2006) Introducing Fractal Geometry. Icon Books, Cambridge, p 176
Mentis MT (1981) Evaluation of the wheel-point and step-point methods of veld condition assessment. Proc Grassld Soc Sth Afr 16:89–94
Mentis MT, Ellery WN (1998) Environmental effects of mining coastal dunes: conjectures and refutations. S Afr J Sci 94:215–222
Porter ME, Kramer MR (2006) Strategy and society: the link between competitive advantage and corporate social responsibility. Harv Bus Rev 2006:78–92
Sheldrake R (1987) A New Science of Life: The Hypothesis of Formative Causation. Paladin Books, London, p 287
Starfield AM, Smith KA, Bleloch AL (1994) How to Model It: Problem Solving for the Computer Age. Interaction Book Company, Edina, p 208
Taleb NN (2004) Fooled by Randomness: The Hidden Role of Chance in Life and in the Markets. Penguin, London, p 316
Taleb NN (2012) Antifragile: How to Live in a World We Don't Understand. Penguin, London, p 519
Watson JD (1968) The Double Helix. Weidenfeld and Nicolson, London, p 235
I thank Klaus von Gadow for prompting this article, and 'Student' for
This is an Open Access article distributed under the terms of the Creative Commons Attribution License ( http://creativecommons.org/licenses/by/2.0), which permits unrestricted use, distribution, and reproduction in any medium, provided the original work is properly credited.