Search icon Close icon
Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Checkout

Change country

Modal Close icon
Country selected Country selected
country flag Germany
Country selected
country flag Slovakia
Country selected
country flag Canada
Country selected
country flag Brazil
Country selected
country flag Singapore
Country selected
country flag Hungary
Country selected
country flag Philippines
Country selected
country flag Mexico
Country selected
country flag Thailand
Country selected
country flag Ukraine
Country selected
country flag Luxembourg
Country selected
country flag Estonia
Country selected
country flag Lithuania
Country selected
country flag Norway
Country selected
country flag Chile
Country selected
country flag United States
Country selected
country flag Great Britain
Country selected
country flag India
Country selected
country flag Spain
Country selected
country flag South Korea
Country selected
country flag Ecuador
Country selected
country flag Colombia
Country selected
country flag Taiwan
Country selected
country flag Switzerland
Country selected
country flag Indonesia
Country selected
country flag Cyprus
Country selected
country flag Denmark
Country selected
country flag Finland
Country selected
country flag Poland
Country selected
country flag Malta
Country selected
country flag Czechia
Country selected
country flag New Zealand
Country selected
country flag Austria
Country selected
country flag Turkey
Country selected
country flag France
Country selected
country flag Sweden
Country selected
country flag Italy
Country selected
country flag Egypt
Country selected
country flag Belgium
Country selected
country flag Portugal
Country selected
country flag Slovenia
Country selected
country flag Ireland
Country selected
country flag Romania
Country selected
country flag Greece
Country selected
country flag Argentina
Country selected
country flag Malaysia
Country selected
country flag South Africa
Country selected
country flag Netherlands
Country selected
country flag Bulgaria
Country selected
country flag Latvia
Country selected
country flag Australia
Country selected
country flag Japan
Country selected
country flag Russia
Country selected
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
Concepts
Arrow right icon
Author (1):
Arrow left icon
Chris Chinchilla Chris Chinchilla
Author Profile Icon Chris Chinchilla
Chris Chinchilla
LinkedIn
Chris Chinchilla spent years as a developer before switching to helping people understand code better instead of writing it. He has worked crafting documentation for many developer-focused projects, from small open-source projects to large and well-known tools and products, tackling everything from tooling to videos. He is known for bringing developers and writers closer with editor and automation-based tools. Outside of tech writing, he publishes fiction, YouTube videos, podcasts, and music. In short, he loves to communicate and find the best medium for the message.
Read more
See other products by 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

An example of a well-structured page

Continuing to use the Monito example, here’s a Skeleton of how I might structure a Getting Started page with plenty of headings, code tabs, admonitions, and more:

Figure 4.3 – A layout showing an example of a well-structured page

Figure 4.3 – A layout showing an example of a well-structured page

lock icon The rest of the chapter is locked
arrow left Previous Section
Section 6 of 8
Next Section arrow right
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.
Sign up now
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
Start free trial
Renews at $19.99/month. Cancel anytime

Authors (1)

Profile icon Chris Chinchilla
Chris Chinchilla
LinkedIn icon
Chris Chinchilla spent years as a developer before switching to helping people understand code better instead of writing it. He has worked crafting documentation for many developer-focused projects, from small open-source projects to large and well-known tools and products, tackling everything from tooling to videos. He is known for bringing developers and writers closer with editor and automation-based tools. Outside of tech writing, he publishes fiction, YouTube videos, podcasts, and music. In short, he loves to communicate and find the best medium for the message.
Read more
See other products by Chris Chinchilla
Banner background image

Personalised recommendations for you

Based on your interests and search pattern
Left arrow icon
Mastering Customer Success
Mastering Customer Success
Read more
This guide unveils strategies to cultivate enduring customer relationships. Grounded in effective communication and problem-solving, it shows you how to harness cross-functional collaboration for competitive advantage.
Read more
May 2024 5h 40m
Mastering Customer Success
Mastering Customer Success
Read more
This guide unveils strategies to cultivate enduring customer relationships. Grounded in effective communication and problem-solving, it shows you how to harness cross-functional collaboration for competitive advantage.
Read more
May 2024 5h 40m
Mastering Customer Success
Mastering Customer Success
Read more
This guide unveils strategies to cultivate enduring customer relationships. Grounded in effective communication and problem-solving, it shows you how to harness cross-functional collaboration for competitive advantage.
Read more
May 2024 5h 40m
Mastering Customer Success
Mastering Customer Success
Read more
This guide unveils strategies to cultivate enduring customer relationships. Grounded in effective communication and problem-solving, it shows you how to harness cross-functional collaboration for competitive advantage.
Read more
May 2024 5h 40m
Mastering Customer Success
Mastering Customer Success
Read more
This guide unveils strategies to cultivate enduring customer relationships. Grounded in effective communication and problem-solving, it shows you how to harness cross-functional collaboration for competitive advantage.
Read more
May 2024 5h 40m
Mastering Customer Success
Mastering Customer Success
Read more
This guide unveils strategies to cultivate enduring customer relationships. Grounded in effective communication and problem-solving, it shows you how to harness cross-functional collaboration for competitive advantage.
Read more
May 2024 5h 40m
Mastering Customer Success
Mastering Customer Success
Read more
This guide unveils strategies to cultivate enduring customer relationships. Grounded in effective communication and problem-solving, it shows you how to harness cross-functional collaboration for competitive advantage.
Read more
May 2024 5h 40m
Mastering Customer Success
Mastering Customer Success
Read more
This guide unveils strategies to cultivate enduring customer relationships. Grounded in effective communication and problem-solving, it shows you how to harness cross-functional collaboration for competitive advantage.
Read more
May 2024 5h 40m
Mastering Customer Success
Mastering Customer Success
Read more
This guide unveils strategies to cultivate enduring customer relationships. Grounded in effective communication and problem-solving, it shows you how to harness cross-functional collaboration for competitive advantage.
Read more
May 2024 5h 40m
Mastering Customer Success
Mastering Customer Success
Read more
This guide unveils strategies to cultivate enduring customer relationships. Grounded in effective communication and problem-solving, it shows you how to harness cross-functional collaboration for competitive advantage.
Read more
May 2024 5h 40m
Mastering Customer Success
Mastering Customer Success
Read more
This guide unveils strategies to cultivate enduring customer relationships. Grounded in effective communication and problem-solving, it shows you how to harness cross-functional collaboration for competitive advantage.
Read more
May 2024 5h 40m
Mastering Customer Success
Mastering Customer Success
Read more
This guide unveils strategies to cultivate enduring customer relationships. Grounded in effective communication and problem-solving, it shows you how to harness cross-functional collaboration for competitive advantage.
Read more
May 2024 5h 40m
Right arrow icon