Writing a technical book

Founder of wealthy gorilla read full profile writing can be a struggle for even the mos. Come together and help us to keep our literature sharp and accurate. In the earliest stages, the idea was that id write a couple of appendices and help transform peter and vadims writing into book quality material. For technical books theres also plenty of opportunities to write more books, for example when a new release comes out for the technology you focus on. It is important for us to keep our manuals updated and precise. Writing technical books a guide to getting started. The reality of writing a technical book is that the technology will change while you are writing it and there is not really much that you can do about this. I want to write technical books libreoffice documentation. Motivation, publishing and how to stay focused without ruining your life by adam tornhill, may 2015 do you dream of writing your own technical book. Some publishers manage to get books out very quickly, and often it shows.

Ive summarized the 4 main steps to writing and publishing your first technical. Whisper it, but writing a book will force you into corners of the technology you might not otherwise look into. Writing a book earns you visibility, credibility and respect. A best seller makes millions of dollars for the publisher, and hundreds of. Aug 14, 2018 the process of writing a technical book is fraught with impedance mismatches the misalignment of the goals between the author and publisher.

A different set of people will read the material than if i had put it up for free on the web. By now i am quite comfortable with the process of writing an article or a tutorial. The process of writing a technical book is fraught with impedance mismatches the misalignment of the goals between the author and publisher. A best seller sells over 100,000 remember these are technical books we are talking about, not other areas like fiction which is completely different. From there i complete the programming aspects, this usually involves finding print problems, out of date code or typos.

Get known writing a book earns you visibility, credibility and respect. Check out the previous posts on why you should and shouldnt write a book and how to find a publisher. The goal is to write a book that gets the author hired or promoted, or to land consulting gigs, or to get vc backing. The author writes or authors write the first draft. In the modern digital and online market, the idea of publisher as some sort. When a teacher or anyone else asks you to write a book summary, he or she is requesting that you read a book and write a short account that explains the main plot points, characters and any other important information in your own words. Technical and professional writing genres beta simple. The delay knob moves the main sweep horizontally, and it pauses at 0. Remember that most people consider authors of technical books as experts, and this perception matters. Writing a book is a very different experience than writing code or blogging. Readers will also learn about other professional communication, designing documents, and creating and. To learn more about the subject matter which i like love 3. As author or coauthor of twelve books focused or touching on technology.

Dec 30, 2020 youll spend a lot of time writing your book. In our fast evolving field theres an endless amount of new topics to cover and timeless. At a minimum, id start blogging on the topic before tackling a book. And i have seen many authors afraid to write a book, for any number of reasons that usually boils down to the fear it will make them look stupid, so they install a writing assistant but never write a page. Discussions of multiple writing genres will assist you in understanding how to apply for jobs, how to compose clear and precise business communications once the job has been acquired, and how to create documents such as. I just finished writing my first book, productionready microservices, and ive gotten a lot of questions about how i approached it, how i wrote it. Ive never written a single work of this length before and i like a challenge. All errors get reported to the publisher for their errata. Early rate through december 4 at least a few times a week i receive messages from people asking me how to write a book. But most of all, the publisher wants to publish something. Id actually been thinking about the idea for a few months, having sent a series of unreturned cold emails to an o. For a comprehensive book like a college text, it will take longer. Financial rewards are rarely large, and for most technical books they are symbolic.

If you think you have a book inside you, this is what you need to know. If you are an author and got signed up with a publisher. The reality of writing a technical book manuel bernhardt. Dec 17, 2017 recently, ive finished writing a technical book, called developing conversational interfaces for ios, which will be published by apress early next year.

Write a reference book or a learning book, not both. Being able to write a book, in my eyes, provides some form of life after death. The rest of this post is a brief laundry list of tips for writing your own technical book. I thought i knew a lot about docker before i started, but writing a book forced me to up my game. Writing my first technical book chapter nick desaulniers. Writing stack exchange is a question and answer site for the craft of professional writing, including fiction, nonfiction, technical, scholarly, and commercial writing. I spent the last year and a half writing my first technical book for oreilly programming typescript. Writing a book is hard workyou dont want clunky software slowing you down, so go with what you know and with what feels right to you. Writing a book is a lot of writing even if you do a shorter one. The feedback can range from guidance to praise, thus allowing for both parties to engage in discussion regarding whats working and what isnt.

This open textbook offers students of technical writing an introduction to the processes and products involved in professional, workplace, and technical writing. Here are some important reasons why you should consider writing your first technical book. A common mistake is to try to write an all encompassing book which. For topics that change very fast, you can update your existing book and make it available to your customers, increasing the value of their purchase and generating goodwill and hopefully more. Van laan lists quite a few books, conferences, professional organizations, websites and other venues for continuing ones education, and she also peppers in trivia, references to technical writing in popular culture, and evidence of the lighter side of tech writing making it a quick and entertaining read that left me feeling.

A succcessful technical book is one that sells over 20,000 copies. Jul 15, 2016 the reality of writing a technical book is that the technology will change while you are writing it and there is not really much that you can do about this. This post details that journey in intricate detail. For technical books, this includes screen shots and code snippets. Let me help you cut through the morass of howto books. Writer by zoho, also known as zoho writer, is an online word processor that comes. You are probably college educated and your ojt experience has given you. You want to ensure that anyone who reads what youve written understands your technical messages. One day, i got a cold email from packt publishing asking me to write a book on typescript. From 2017 until 2019 i spent a lot of my spare time writing a technical book.

A practical guide for engineers and scientists enables readers to write, edit, and publish materials of a technical nature, including books, articles, reports, and electronic media. Sep 22, 2020 i have been writing technical articles and tutorials since late 2018. Writing about highly technical content places an upper limit on the usefulness of the content, and shows as dated quickly. Improve your technical writing skills with these helpful hints to create topnotch business plans, web content, and research projects. People are like sea glass, the longer and harder they are tossed around, the more beautiful they are. Writing may also include quotes from others or other books. He is the author of several books on db2 9 and the owner of his own database design company. Begin writing a post, compare this book to previous ones and alternatives on the market. Whether you signed on with a company as an official technical writer, or you just happen to find yourself.

You also enhance your credibility amongst your colleagues, friends and even relatives. What puzzles me is why most people writing book length technical work in 2019 should use a traditional publisher at all. He has had articles published in certification magazine and idug solutions journal, has authored tutorials for ibms developerworks website, presented at numerous computer conferences, and taught classes on db2. I was to be sort of like a glorified technical editor.

The premise that a publisher deserves to keep the vast majority of sales revenue because of the value they add seems like it belongs in another time. The best fonts for books 5 perfect fonts for typesetting. Writing a book, particularly one on a hot new technology, has an inevitable tension between wanting to get the book to market as quickly and therefore as cheaply man hours on the editing cost bucks and producing as high quality a book as possible. While part of the book editing associates network, he has edited over 100 books, articles, stories, poems. At the top of the graticule is a solid triangle symbol and an open trian. With this simple primer, youll learn how to assess a process, interview subject. If youre writing a technical document, your goal is not to make it beautiful. Aug, 2018 the author writes or authors write the first draft. Apr 05, 2021 this is my third post on publishing a technical book. I tried to find the right balance between picking interesting examples and stable ones. Our books and guides are the references for many end users and professionals that install, deploy, manage, teach and advise on libreoffice software. I hope you do our programming profession needs more highquality books.

Based on whether you contacted them or they contacted you, the author need to come up with a proposal that includes list of chapter and summary of the c. And books from name publishers in the space will have more. What software is good for writing a technical book. Ever wanted to know what its like to write a technical book. The simple, fivestep guide that anyone can use to create technical documents such as user guides, manuals, and procedures kieran morgan 4. The only software you need to write a book is already on. Though, one could imagine ancestors reading blog posts from long dead relatives via utilities like the internet archives wayback machine. A best seller makes millions of dollars for the publisher, and hundreds of thousands for the author. Advice if you are first time author to be, choose your niche domain as one which you are passionate about and which has been generating some buzz lately. The goal is not to write a book that directly makes money. Spend your evenings in mcdonalds if you need extra cash. Motivation, publishing and how to stay focused without ruining your life. Dec 27, 2012 if you are writing a novel, or a poetry book, or a technical book, approval rates will depend on current interest in that domain.

Our technical writing and technical editing specialists make sure your technical documents are linguistically correct and precise. A common mistake is to try to write an all encompassing book which includes every good idea or technique youve ever thought of. May 02, 2017 read the book which can take a minimum of 35 hours. Aug 17, 2020 based on the authors combined experience as engineering educators, the book presents a novel approach to technical writing, positioning formal writing tasks as engineering design problems with requirements, constraints, protocols, standards, and customers readers to satisfy. The first step to getting your first book published is to. Tongueincheek title notwithstanding, this book is a powerful entrylevel pathway to a successful technical writing career. If the writer isnt passionate the reader likely wont be either. This instructable designed to be a bit of a crash course on english, interspersed with strategies one can use when doing documentation, an idea pitch, or in your own lives. Jun 15, 2008 peter zaitsev contacted me about a year ago and asked if id like to help write the book. Finding the time overall id estimate writing the book, including the proposal process, took us each around 400 hours over a year and a half. Jan 07, 2021 more specifically, writing a technical book means being a point of reference with regard to a particular topic. If you have a story youre itching to tell but dont feel confident in your writing, check out this guide to improving your writing.

This is a very fresh take on a classic book for technical writers. We can also help you transform complex technical jargon into easytofollow instructions and information. This doesnt count the work promoting the book after it was out, which ill talk. For the average technical book, if you work at it regularly, it should take six months to a year.

It takes more than just writing skill to write a good manual. I understand how to approach the article and which tools i should use. Writing a technical book with manning in 2020 by milan. Either fortunately or unfortunately, theres no single correct way.

This modern, opensource guide to technical and professional writing explores workplace composition through theoretical and practical applications. But when it comes to book writing and especially a technical book the arena is quite different. Early rate through december 4 my fifth book is going through final edits as i t. This post details my experience coauthoring an oreilly book with my colleagues lak and mike. In fact, prior to the 300page book, the longest thing id written was a 20somethingpage paper in college. Grammarly every word processor will check your spelling and grammar for basic mistakes. If youre an entrepreneur who has been through the ringer in life or business and willing to share, selfpublishing can be powerful. Our book, machine learning design patterns, is available to order now and all royalties go to girls who code. I am often asked for more information about writing a technical book. Jun 17, 2020 the handbook of technical writing with 2020 apa update 12th edition by gerald j. A technical book will give you visibility in your area of work. A dream team of techcomm professionals incorporated decades of handson experience in technical writing on the pages of this book. Sharing a product you have spent time, energy, and money on is rewarding. I have been the author afraid to write a book and using a distraction to avoid this fear many times.

When diving into a technical book, your reader will likely want to explore the what if and how do you questions. The text is broken up into sections reflecting key components of researching, developing, and producing a technical report. From the 804 days or 114 weeks and 6 days of writing duration i estimate that i spent roughly 2 days week with researching, writing, coding. Dec 26, 2018 this article talks about the process of writing a technical book, including how to start and what it takes to make it a successful book.

The only software you need to write a book is already on your. For a lot of the authors of technical books, credibility is the whole point. Sanders has been writing technical articles and books for more than 14 years. Written by a renowned engineer and widely published technical author, this guide complements the traditional writers. Nov 17, 2020 ever wanted to know what its like to write a technical book.

330 389 84 123 453 1476 210 1246 169 654 759 139 765 230 170 358 826 1450 780 1197 823 146 724 861 562 511 1061