| Description |
1 online resource |
| Contents |
Cover -- Title Page -- Copyright and Credits -- Contributors -- Table of Contents -- Preface -- Chapter 1: The Why, Who, and How of Tech Writing -- Why should you care about tech writing? -- What can documentarians accomplish? -- Marketing -- Product -- Sales -- Support -- Developer relations -- Engineering -- Machine readers -- Proofreading for accuracy and safety -- Content silos -- Writer in the middle -- Understanding who you are writing for -- Learning by example -- Don't forget the end users and the end-end users -- Summary |
|
Chapter 2: Understanding Different Types of Documentation in Software Development -- Templates -- Getting started and onboarding -- A detailed overview of Getting Started -- Learning with an example -- Templates for a Getting Started guide -- Tutorials -- Expanding on the example -- Templates for tutorials -- Reference -- API documentation -- Architecture and design details -- Security and privacy details -- Technical blog posts -- Summary -- Chapter 3: Language and the Fundamental Mechanics of Explaining -- Common reasons for not writing confidently -- Not a native speaker |
|
Intentionally vague -- Marketing and product reasons -- Reducing cognitive load -- Inclusive language -- How to improve your writing -- Consistency -- Involving the user -- Keeping it short -- Removing unnecessary words -- Don't show off -- let the product speak for itself -- Don't repeat yourself -- Inclusive language: in more detail -- Overly negative language -- Biased language -- Gender -- Out-of-date language -- Summary -- Chapter 4: Page Structure and How It Aids Reading -- Humans are not your only readers -- The principles of good layout -- A quick primer on the markup language of the web |
|
Thinking about pages semantically -- Lists -- Paragraph breaks -- Tables -- Admonitions -- Tabs -- An example of a well-structured page -- Creating documentation menus and navigation -- Following menu patterns -- Adding internal search -- Keeping links working -- Summary -- Chapter 5: The Technical Writing Process -- Scoping and requirements gathering -- What to document -- Research and product testing -- Drafting and re-drafting -- Feedback, testing, and maintenance -- Metrics and measuring success -- Summary -- Chapter 6: Selecting the Right Tools for Efficient Documentation Creation |
|
Topic-based documentation -- Docs as code -- Documentation in the browser -- Choosing toolchains and tools -- Why docs as code? -- Selecting and using a markup language -- Adding metadata to markup with YAML -- Making Markdown dynamic with MDX -- The key tools in docs as code -- Text editor -- Collaboration -- Rendering -- Helping less technical writers with headless CMS -- Analyzing documentation performance -- Analytics tools -- Sentiment -- Summary -- Chapter 7: Handling Other Content Types for Comprehensive Documentation -- We are more than technical writers -- Code examples |
| Summary |
"Elevate your software development process with expert technical writing skills, fostering clarity, collaboration, and successful product outcomes Key Features 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 Book 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. 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 Who this book is 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." |
| Subject |
Computer software -- Development.
|
|
Technical writing.
|
|
technical writing.
|
| Form |
Electronic book
|
| ISBN |
9781835083918 |
|
1835083919 |
|
