All Products

Best Sellers

New Releases

Books

Videos

Audiobooks

Free Learning

Technical Writing for Software Developers

You're reading from Technical Writing for Software Developers

Product type Book

Published in Mar 2024

Publisher Packt

ISBN-13 9781835080405

Pages 166 pages

Edition 1st Edition

Languages

Concepts

Management Software

Author (1):

Chris Chinchilla

Table of Contents (12) Chapters

Preface

1. Chapter 1: The Why, Who, and How of Tech Writing

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

Why subscribe?

11. Other Books You May Enjoy

Summary

This chapter looked at how to make your wonderful words readable to all interested in consuming them. It looked at how you can use simpler and more complex page elements to add space and context to the information it presents.

If there are two pieces of advice to take away from this chapter, they are as follows:

Your content needs to be readable as well as well-written
There are many more readers of your documentation in addition to human eyes

With some underpinning practical techniques in place, the next chapter looks at the process you must follow to start and continue writing.

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

Start free trial

Renews at $15.99/month. Cancel anytime}

Authors (1)

Chris Chinchilla

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

Personalised recommendations for you

Based on your interests and search pattern

Engineering Manager's Handbook

Engineering Manager's Handbook

Engineering Manager's Handbook is a comprehensive guide for managers to excel in their role, foster customer-centric digital products, learn leadership, team building, and balancing technical work with management. You’ll also explore how to develop trust, authority, and collaboration to drive success and make a lasting impact.

Sep 2023 9 hours 16 minutes

C++ Game Animation Programming

C++ Game Animation Programming

Video game characters have a fascinating history, evolving from simple 2D sprites to high-polygon 3D models. Take a look behind the curtain and learn how to build a 3D renderer, load character models, play animations and blend between them, and create large crowds of animated people with this comprehensive C++ game animation programming guide.

Dec 2023 16 hours 0 minutes

Gamification for Product Excellence

Gamification for Product Excellence

This book helps you to take your product management strategy to the next level by standing out in crowded markets. Along with boosting user adoption rates by creating engaging products that incorporate playful elements, learn gamification theory and how to integrate it into your design, product development, and product management processes.

Sep 2023 11 hours 40 minutes

Supercharging Productivity with Trello

Supercharging Productivity with Trello

Supercharging Productivity with Trello is the ultimate guide for anyone looking to boost their productivity with digital tools. Whether you're new to Trello or a seasoned professional, this book covers everything from core features to advanced automation, and Power-Ups.

Aug 2023 11 hours 24 minutes

Automate It with Zapier and Generative AI

Automate It with Zapier and Generative AI

This comprehensive guide takes you through the concepts of business process automation, showing you how Zapier can facilitate it without having to write code and helping you to boost productivity. You’ll learn how to save time, reduce costs, and make your business recession-proof by using Zapier to automate tasks in your cloud-based business apps.

Aug 2023 23 hours 32 minutes

Scoring to Picture in Logic Pro

Scoring to Picture in Logic Pro

In this book, you’ll explore a variety of techniques to synchronize music to picture using Logic Pro. Though this is not a technical manual, it will teach you how to make the best use of Logic Pro and how to wield this technology to maximize your potential when scoring to picture.

Sep 2023 13 hours 44 minutes

Mastering Information Security Compliance Management

Mastering Information Security Compliance Management

This concise book equips you with the knowledge and practices needed to establish and maintain an effective information security management system. The chapters provide insights into ISO/IEC 27001/27002:2022, risk management, ISMS development, incident management, audit processes, and strategies for continuous improvement.

Aug 2023 7 hours 52 minutes

Implementing Atlassian Confluence

Implementing Atlassian Confluence

Implementing Atlassian Confluence provides both a high-level overview and an insightful path for remote collaboration with Atlassian Confluence. With this multi-layered yet practical guide, you’ll be able to set up Confluence-based collaboration with minimum external consultancy services to ensure smooth and close coordination between teams.

Sep 2023 13 hours 32 minutes

R Bioinformatics Cookbook

R Bioinformatics Cookbook

This book takes a unique problem–solution approach to handling complex tasks in the bioinformatics domain using different datasets present in the book. With the help of real-world examples, you’ll learn to put each independent recipe to use to tackle problems in the field of bioinformatics.

Oct 2023 13 hours 12 minutes

Build Your Own Metaverse with Unity

Build Your Own Metaverse with Unity

Build Your own Metaverse with Unity is a practical guide for developers to create their own metaverse - a virtual world with infinite possibilities. It empowers you to identify gaps in existing metaverses and improve upon them, enabling you to shape your virtual world.

Sep 2023 19 hours 32 minutes