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
Newsletter Hub
Free Learning
Arrow right icon
timer SALE ENDS IN
0 Days
:
00 Hours
:
00 Minutes
:
00 Seconds
Technical Writing for Software Developers
Technical Writing for Software Developers

Technical Writing for Software Developers: Enhance communication, improve collaboration, and leverage AI tools for software development

eBook
$20.99 $30.99
Paperback
$37.99
Subscription
Free Trial
Renews at $19.99p/m

What do you get with Print?

Product feature icon Instant access to your digital copy whilst your Print order is Shipped
Product feature icon Paperback book shipped to your preferred address
Product feature icon Redeem a companion digital copy on all Print orders
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
Product feature icon AI Assistant (beta) to help accelerate your learning
OR
Modal Close icon
Payment Processing...
tick Completed

Shipping Address

Billing Address

Shipping Methods
Table of content icon View table of contents Preview book icon Preview Book

Technical Writing for Software Developers

Understanding Different Types of Documentation in Software Development

Chapter 1 of this book looked at why you and your project or product should even care about documentation. With the convincing and scene setting complete, it’s time to start looking at the mechanics of good documentation, starting with the types of documentation you might need to create.

The simplest documentation can be a single README file in a code repository, while the most complex could be a series of interconnected sections, topics, and sub-projects. As documentation expands into more complex territory, it’s likely to need different sorts of pages that cover different purposes and have different structures. This chapter covers the common section types you might typically have in most documentation, what they are likely to contain, and the templates you can use to create them.

Different people have different names for these sections, but the content in each section is loosely the same and...

Templates

Before getting started, I want to provide a quick diversion that covers templates and how to apply and use them before you start documentation from scratch. Content templates typically consist of headings or sections that you can add to different content types, optionally with prompts and guidance on what to add under each heading. Over time, documentarians tend to create their own templates, adding them to content creation workflows for all to use. If you’re unsure where to start with templates, I recommend community resources such as the Good Docs project (https://thegooddocsproject.dev), which has worked hard to create many starter documentation templates for people to pick up and use. For each content type covered in this chapter, I include links to relevant templates from the project and/or my thoughts on a template you can start with.

So, let’s actually get started.

Getting started and onboarding

This content type helps people learn how to get started with a project or features.

Most inexperienced users start their journey with you via a Getting Started guide or onboarding experience. Getting Started, sometimes called a QuickStart, is typically a text-based guide that contains other media or interactive components.

Onboarding is sometimes called a tour or in-app help and is typically part of an app or product experience. It contains text that you might be involved in creating (I would say “should,” but that’s not always the case).

A detailed overview of Getting Started

I already covered some aspects of creating Getting Started guides in Chapter 1, but it’s a big topic, so the content you are likely to spend the most initial time on is worth covering in more detail. Whether you call it Getting Started, QuickStart, or onboarding, the first steps a user or potential user makes with a product are crucial.

...

Tutorials

If a Getting Started guide showcases what’s best about your product and gets new users started on their journey with you, then tutorials, sometimes called how-tos or guides, take them on the next steps.

As you might expect, the breadth and detail of tutorials or guides depends on your project, but here’s my general advice.

If your product or project has identifiable sections or sub-projects, they need tutorial sections. Do you support different ways to use your product – for example, a Command-Line Integration (CLI) tool, a visual interface, and an Application Programming Interface (API)? Perhaps you also support continuous integration (CI) or have applications and plugins in third-party marketplaces? If so, all of these need at least one tutorial on how to use them. If one of these sub-areas is particularly complex – for example, the visual interface has many different sections, or the Software development kit (SDK) consists of several components...

Reference

This section includes technical details of how individual components, functions, or APIs work.

I have always considered the differentiation between reference documentation and everything else in the following way:

  • A reference document tells you that a hammer is for hitting things, wood is from dead trees that you can build things with, and nails are small, sharp, pointed bits of metal
  • A guide or tutorial tells you how to build a shed with wood, hammer, and nails

Depending on the project and technology type, a reference section could include the following:

  • SDK function details
  • API endpoint details
  • Architecture and design details
  • Security and privacy details
  • Whitepapers and academic papers

The terms API and SDK can sometimes be used interchangeably, depending on the project or product.

I start with SDK documentation, as you can typically build the reference documentation as you build your code.

Most SDK methods help...

Technical blog posts

A blog post is an end-to-end, self-contained piece of content, normally outside of documentation, that teaches the reader a practical technical lesson.

While not always a content type a documentarian is asked to write, you may be asked to help out, especially in smaller companies where you are one of the few people with the desire and skills to communicate clearly. Blog posts are often a good way to learn about a product or feature from start to finish. As blogs are usually promoted by marketing, outside of QuickStarts, they are also often the first way someone discovers a project, so they are worth doing well.

Much of the advice on structure and language presented in this book for documentation also applies to technical blog posts. There are a couple of main differences.

People generally read documentation when they need to, dipping in and out to find the information they need at the time, whereas most people read a blog post from start to finish, hopefully...

Summary

This chapter covered the different documentation types you need to create to fully document a project or product. These are as follows:

  • Getting started, onboarding, or QuickStart: How people take the first steps with your project or product and some of the standout features
  • Tutorials, guides, or how -tos: Further step-by-step instructions that cover particular use cases or features
  • Reference: In-depth details about the function of individual components or the principles behind them

The next chapters cover how to write the content for these document types, starting with every writer’s favorite topic… grammar!

Left arrow icon Right arrow icon

Key benefits

  • Optimize documentation workflows with collaborative version-controlled "docs-as-code" tooling options
  • Engage with interactive learning modules embedded throughout the book
  • Improve software quality as a lead developer through effective communication in documentation
  • Purchase of the print or Kindle book includes a free PDF eBook

Description

Effective documentation is key to the success of products in remote software development teams, facilitating clear instructions that benefit the entire development team. Technical Writing for Software Developers lays a solid foundation of essential grammar, providing language tips and explaining how precise writing enhances documentation, and walks you through the fundamental types and styles of documentation. Starting with an exploration of the current state of the tech writing industry and its significance in both the software and hardware realms, you’ll master the building blocks of technical writing, exploring tooling choices and style guides, and create dynamic multimedia-laden documentation. This book equips you with valuable insights into the writing and feedback process to ensure continuous improvement. Additionally, you’ll take a peek at the emerging trends and technologies, including AI tools, shaping the future of technical writing. By the end of this technical writing book, you’ll have developed the expertise you need to tackle documentation requests effectively, armed with the knowledge of the best approach for documenting any topic, encompassing text, media elements, structure, and appropriate tools. The skills acquired will enable you to achieve seamless teamwork, enhanced project efficiency, and successful software development.

Who is this book for?

This book is for software developers who want to improve their technical writing prowess. Whether you are a junior developer looking to refine your documentation skills or a professional striving for smoother collaboration, this resource equips you with all the essential knowledge and practical insights you need. Covering everything from creating clear documentation to enhancing career prospects, this book caters to a diverse range of software developers, including programmers, software architects, and software engineers looking to streamline the product development process and save time.

What you will learn

  • Create engaging multimedia-rich documentation
  • Understand the types and styles of documentation
  • Discover grammar and language tips for clear communication
  • Streamline your documentation process with the right tooling choice
  • Master the writing and feedback process for continuous improvement
  • Explore automation techniques for efficient documentation workflows
  • Embrace AI-powered tools for enhanced technical writing
Estimated delivery fee Deliver to United States

Economy delivery 10 - 13 business days

Free $6.95

Premium delivery 6 - 9 business days

$21.95
(Includes tracking information)

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Mar 29, 2024
Length: 166 pages
Edition : 1st
Language : English
ISBN-13 : 9781835080405
Tools :

What do you get with Print?

Product feature icon Instant access to your digital copy whilst your Print order is Shipped
Product feature icon Paperback book shipped to your preferred address
Product feature icon Redeem a companion digital copy on all Print orders
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
Product feature icon AI Assistant (beta) to help accelerate your learning
OR
Modal Close icon
Payment Processing...
tick Completed

Shipping Address

Billing Address

Shipping Methods
Estimated delivery fee Deliver to United States

Economy delivery 10 - 13 business days

Free $6.95

Premium delivery 6 - 9 business days

$21.95
(Includes tracking information)

Product Details

Publication date : Mar 29, 2024
Length: 166 pages
Edition : 1st
Language : English
ISBN-13 : 9781835080405
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
$19.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
$199.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts
$279.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total $ 127.97
Kubernetes Secrets Handbook
$44.99
Technical Writing for Software Developers
$37.99
Mastering Prometheus
$44.99
Total $ 127.97 Stars icon

Table of Contents

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

Customer reviews

Rating distribution
Full star icon Full star icon Full star icon Full star icon Half star icon 4.3
(3 Ratings)
5 star 33.3%
4 star 66.7%
3 star 0%
2 star 0%
1 star 0%
Amazon Customer May 16, 2024
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Technical Writing for Software Developers" by Chris Chinchilla is an invaluable resource for any software developer aiming to improve their documentation skills. The author covers everything from understanding your audience to structuring documents and using visuals effectively, all with practical tips and real-world examples.What sets this book apart is its focus on the unique challenges faced by software developers, such as documenting APIs and writing clear code comments. The advice on integrating documentation into the development workflow is particularly helpful.The book is well-organized, easy to read, and includes summaries and exercises at the end of each chapter, making it easy to apply the concepts.Whether you're an experienced developer or just starting, this book will help you produce better documentation and improve your communication skills. Highly recommended!Pros:Tailored for software developersPractical tips and examplesCovers a wide range of topicsEasy to read and well-organizedHelpful exercises and summaries
Amazon Verified review Amazon
Jorge Deflon May 21, 2024
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
A practically sure way to increase productivity among development teams is to improve communication between its elements, and a considerable percentage of theseA considerable percentage of communication in development work teams is done in writing, Therefore, the material to improve this type of communication is increasingly important. I am starting to read this book to improve my written communication with the other members of the team and to date it has been positive.
Amazon Verified review Amazon
Olabayo Balogun Jun 02, 2024
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
It covered a lot of things that both beginners and experts need to know about technical writing
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is the digital copy I get with my Print order? Chevron down icon Chevron up icon

When you buy any Print edition of our Books, you can redeem (for free) the eBook edition of the Print Book you’ve purchased. This gives you instant access to your book when you make an order via PDF, EPUB or our online Reader experience.

What is the delivery time and cost of print book? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela
What is custom duty/charge? Chevron down icon Chevron up icon

Customs duty are charges levied on goods when they cross international borders. It is a tax that is imposed on imported goods. These duties are charged by special authorities and bodies created by local governments and are meant to protect local industries, economies, and businesses.

Do I have to pay customs charges for the print book order? Chevron down icon Chevron up icon

The orders shipped to the countries that are listed under EU27 will not bear custom charges. They are paid by Packt as part of the order.

List of EU27 countries: www.gov.uk/eu-eea:

A custom duty or localized taxes may be applicable on the shipment and would be charged by the recipient country outside of the EU27 which should be paid by the customer and these duties are not included in the shipping charges been charged on the order.

How do I know my custom duty charges? Chevron down icon Chevron up icon

The amount of duty payable varies greatly depending on the imported goods, the country of origin and several other factors like the total invoice amount or dimensions like weight, and other such criteria applicable in your country.

For example:

  • If you live in Mexico, and the declared value of your ordered items is over $ 50, for you to receive a package, you will have to pay additional import tax of 19% which will be $ 9.50 to the courier service.
  • Whereas if you live in Turkey, and the declared value of your ordered items is over € 22, for you to receive a package, you will have to pay additional import tax of 18% which will be € 3.96 to the courier service.
How can I cancel my order? Chevron down icon Chevron up icon

Cancellation Policy for Published Printed Books:

You can cancel any order within 1 hour of placing the order. Simply contact customercare@packt.com with your order details or payment transaction id. If your order has already started the shipment process, we will do our best to stop it. However, if it is already on the way to you then when you receive it, you can contact us at customercare@packt.com using the returns and refund process.

Please understand that Packt Publishing cannot provide refunds or cancel any order except for the cases described in our Return Policy (i.e. Packt Publishing agrees to replace your printed book because it arrives damaged or material defect in book), Packt Publishing will not accept returns.

What is your returns and refunds policy? Chevron down icon Chevron up icon

Return Policy:

We want you to be happy with your purchase from Packtpub.com. We will not hassle you with returning print books to us. If the print book you receive from us is incorrect, damaged, doesn't work or is unacceptably late, please contact Customer Relations Team on customercare@packt.com with the order number and issue details as explained below:

  1. If you ordered (eBook, Video or Print Book) incorrectly or accidentally, please contact Customer Relations Team on customercare@packt.com within one hour of placing the order and we will replace/refund you the item cost.
  2. Sadly, if your eBook or Video file is faulty or a fault occurs during the eBook or Video being made available to you, i.e. during download then you should contact Customer Relations Team within 14 days of purchase on customercare@packt.com who will be able to resolve this issue for you.
  3. You will have a choice of replacement or refund of the problem items.(damaged, defective or incorrect)
  4. Once Customer Care Team confirms that you will be refunded, you should receive the refund within 10 to 12 working days.
  5. If you are only requesting a refund of one book from a multiple order, then we will refund you the appropriate single item.
  6. Where the items were shipped under a free shipping offer, there will be no shipping costs to refund.

On the off chance your printed book arrives damaged, with book material defect, contact our Customer Relation Team on customercare@packt.com within 14 days of receipt of the book with appropriate evidence of damage and we will work with you to secure a replacement copy, if necessary. Please note that each printed book you order from us is individually made by Packt's professional book-printing partner which is on a print-on-demand basis.

What tax is charged? Chevron down icon Chevron up icon

Currently, no tax is charged on the purchase of any print book (subject to change based on the laws and regulations). A localized VAT fee is charged only to our European and UK customers on eBooks, Video and subscriptions that they buy. GST is charged to Indian customers for eBooks and video purchases.

What payment methods can I use? Chevron down icon Chevron up icon

You can pay with the following card types:

  1. Visa Debit
  2. Visa Credit
  3. MasterCard
  4. PayPal
What is the delivery time and cost of print books? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela