Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Free Learning
Arrow right icon
Arrow up icon
GO TO TOP
Technical Writing for Software Developers

You're reading from   Technical Writing for Software Developers Enhance communication, improve collaboration, and leverage AI tools for software development

Arrow left icon
Product type Paperback
Published in Mar 2024
Publisher Packt
ISBN-13 9781835080405
Length 166 pages
Edition 1st Edition
Tools
Arrow right icon
Author (1):
Arrow left icon
Chris Chinchilla Chris Chinchilla
Author Profile Icon Chris Chinchilla
Chris Chinchilla
Arrow right icon
View More author details
Toc

Table of Contents (12) Chapters Close

Preface 1. Chapter 1: The Why, Who, and How of Tech Writing FREE CHAPTER 2. Chapter 2: Understanding Different Types of Documentation in Software Development 3. Chapter 3: Language and the Fundamental Mechanics of Explaining 4. Chapter 4: Page Structure and How It Aids Reading 5. Chapter 5: The Technical Writing Process 6. Chapter 6: Selecting the Right Tools for Efficient Documentation Creation 7. Chapter 7: Handling Other Content Types for Comprehensive Documentation 8. Chapter 8: Collaborative Workflows with Automated Documentation Processes 9. Chapter 9: Opportunities to Enhance Documentation with AI Tools 10. Index 11. Other Books You May Enjoy

Common reasons for not writing confidently

Some are born with a pen in their hands, their fingers on the keyboard, and words flow from their brains easily. Well, they appear to anyway. But for many of us, writing can be a slow process, and different reasons cause our writing not to be the best it could be. This section looks at some of the most common and how to improve them.

Not a native speaker

Let’s face it. While a lot of documentation is in English, many of its readers and writers don’t have English as their native language. English is wonderfully vague and flexible, which is one reason it remains popular and successful as a global language of communication. However, it is full of strange subtleties, and while many understand it, few understand it to an advanced level. This includes many of those who have it as a native language. Many of us learn very little about its grammar and advanced usage. I had my last formal English grammar lesson when I was about 15...

lock icon The rest of the chapter is locked
Register for a free Packt account to unlock a world of extra content!
A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.
Unlock this book and the full library FREE for 7 days
Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of
Renews at $19.99/month. Cancel anytime
Banner background image