Documentation writers8/30/2023 Even if a good picture is worth 10 chocolates!Ĭontinue reading… Funky Tidbits for Technical Writers In other words, there’s more to it than pictures. By engaging our readers’ interest, we are making it easier for them to focus on and understand the information on the page. Attractive and interesting pages attract people. Many people absorb information more quickly from a good image or diagram than from a block of text. What a dream!Ĭontinue Reading… Turning Documentation into CommunicationĮveryone knows the saying: A picture is worth a thousand words. ![]() From that point on, the subject matter experts share the task of maintenance, giving the writers more time to develop new documents. Imagine an ideal world, where technical writers design the structure of a documentation set and create the first version of the documents. In this post we introduce you to one of the 5 Cs of technical communication: Collaboration!Ĭollaboration – that’s what a wiki is designed for. Lets take a look at how Ganache spends a typical day at Choc Ink managing the technical documentation for the company. ![]() Ganache spends most of her day on the wiki. ![]() Two of those tools are ChocTactics and ChocSpice. She is a technical writer at Choc Ink, a fictitious company specializing in software tools for the chocolate industry. Ganache is the hero of Confluence, Tech Comm, Chocolate. In case you didn’t get to read all of the posts here are brief summaries of what we’ve covered over the last month. It will be the perfect way for you to meet Sarah and conclude this great series on using a wiki for technical documentation. To celebrate the end of this series we want to invite everyone to join us for a free webinar on Confluence as a Platform for Technical Documentation. We hope that you have picked up some helpful tips and tricks or even changed the way you think about or produce technical documentation in your organization. We also compile a glossary of your company’s preferred terminology and linguistic guidelines so that all texts share the same style.Over the past month we have explored the world of technical documentation in Confluence and gotten a taste of Sarah Maddox’s new book: Confluence, tech comm, chocolate: A wiki as platform extraordinaire for technical communication. (Some technical writers have the ability to use both halves of their brains and produce a textbook that is both technically precise and interesting.) In other forms of technical documentation, such as learning materials, the author’s ability to write educationally is paramount. It also helps to be a language enthusiast who understands the technical terms and jargon of a specific industry. ![]() Being a perfectionist is undoubtedly an advantage for a technical writer. In technical documentation, such as product data sheets and patent applications, precision is the be-all and end-all. English, Swedish, Finnish or Danish: we can handle your multilingual needs. Samtext’s head office in Oslo has its own technical writers, but Samtext’s offices in other countries also contribute to a network of technical writers. A technical writer can do this for you.Ī training course for driving with a trailer? A user manual for a new car model? Instructions for a dishwasher, product texts for a parts catalogue, knitting patterns for the most intricate designs, safety instructions for flammable substances? Technical documentation in English (and other languages) Technical documentation must be written in a way that makes it maximally understandable to the reader.
0 Comments
Leave a Reply.AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |