Roll over image to zoom in
Modern Technical Writing: An Introduction to Software Documentation
£3.00
This slender volume provides the foundational knowledge to start creating and publishing great software documentation. Written by the lead technical writer at one of Silicon Valley’s most exciting companies, Modern Technical Writing is a set of guiding principles and thoughtful recommendations for new and experienced technical writers alike. Not a reference manual, and not comprehensive, it instead serves as an introduction to a sensible writing and publishing process, one that has eluded the profession for too long.
Read more
Additional information
| Language | English |
|---|---|
| File size | 301 KB |
| Simultaneous device usage | Unlimited |
| Text-to-Speech | Enabled |
| Screen Reader | Supported |
| Enhanced typesetting | Enabled |
| X-Ray | Not Enabled |
| Word Wise | Not Enabled |
| Sticky notes | On Kindle Scribe |
| Print length | 52 pages |
by Christian Mogensen
Covers the basics well.. practical examples show the beginner how to get started with static site builders, git, markdown and ascii-doc.
by R. D. Eager
The publication date is not shown. This makes me a little suspicious.
by Dee Vincent-Day
I am currently researching methods of technical documentation production and found this book an interesting read. However I do not agree that this is the best method. Whilst markdown allows more people to contribute it does not talk about how you manage the readability of text and maintaining a clear “Global” English writing style. It talks of the complexities of managing translations but again does not offer a “Global” English approach which in my experience considerably aids translation. To me the Technical Communicator’s role is about bridging the gap between the developers and the customer. This requires skilled writers of English who understand how to write for global audiences. I have looked at Markdown but feel that the management of topic files, and the intervention required to produce tables and conditional text, would make use of this method very time consuming. It would not be workable for large scale global SAAS systems requiring translations to several languages, nor for systems where you are producing several builds, branded for different customers, where you are extensively using conditional text for custom implementations. However, If there were a choice to be made, I would prefer to use markdown over Word. In essence, if a technical writer has used professional tools tools such as Adobe Technical Communications Suite or Madcap Flare, giving them markdown is like trading down from Photoshop to Paintbrush.