Crafting Docs for Success

Crafting Docs for Success
Author :
Publisher : Apress
Total Pages : 0
Release :
ISBN-10 : 1484295935
ISBN-13 : 9781484295939
Rating : 4/5 (939 Downloads)

Book Synopsis Crafting Docs for Success by : Diana Lakatos

Download or read book Crafting Docs for Success written by Diana Lakatos and published by Apress. This book was released on 2023-09-30 with total page 0 pages. Available in PDF, EPUB and Kindle. Book excerpt: Developer documentation is a powerful tool in developer relations because it provides all the necessary information during the onboarding process and keeps your users informed on changes such as release notes, status reports and new and updated topics. Using a design thinking approach, this book aims to provide an easy to follow blueprint for building successful developer documentation by using the award winning platformOS developer portal as inspiration. You'll work with practical usable templates, workflows, and tools validated and peer-reviewed by international experts in the fields of documentation, technical writing, developer relations, and UX design. This book reveals the many factors that must be considered while crafting developer documentation, such as hitting the right target audience, designing a seamless onboarding experience, and selecting the right workflows and data analysis methods. You'll delve into this complex mix of topics, each with its unique considerations, and understand why it’s difficult for those working on developer documentation to understand the process, as well as all the necessary ingredients, tools, and resources to overcome that challenge. Crafting Docs for Success is your one-stop resource for empowering your team and community to contribute and help maintain your documentation, as well as further improve diversity and inclusion. What You'll Learn Examine how user research facilitates documentation development Utilize design thinking, community-driven documentation, and Docs as Code Understand editorial workflows and what happens at each step Write a style guide from scratch and use it for content production Review how methods and strategies fall into place during technical implementation Who This Book Is For Software developers and designers, documentation maintainers and managers, technical writers, developer relations practitioners and advocates, technical community managers, developer marketers, and start-up founders, CTOs, and CEOs

Crafting Docs for Success Related Books

Crafting Docs for Success
Language: en
Pages: 0
Authors: Diana Lakatos
Categories: Computers
Type: BOOK - Published: 2023-09-30 - Publisher: Apress

GET EBOOK

Developer documentation is a powerful tool in developer relations because it provides all the necessary information during the onboarding process and keeps your
Crafting Your Research Future
Language: en
Pages: 154
Authors: Charles Ling
Categories: Technology & Engineering
Type: BOOK - Published: 2022-05-31 - Publisher: Springer Nature

GET EBOOK

What is it like to be a researcher or a scientist? For young people, including graduate students and junior faculty members in universities, how can they identi
Docs Like Code
Language: en
Pages: 118
Authors: Anne Gentle
Categories: Computers
Type: BOOK - Published: 2018-01-13 - Publisher: Lulu.com

GET EBOOK

Looking for a way to invigorate your technical writing team and grow that expertise to include developers, designers, and writers of all backgrounds? When you t
Crafting Interpreters
Language: en
Pages: 1021
Authors: Robert Nystrom
Categories: Computers
Type: BOOK - Published: 2021-07-27 - Publisher: Genever Benning

GET EBOOK

Despite using them every day, most software engineers know little about how programming languages are designed and implemented. For many, their only experience
Crafting Truth
Language: en
Pages: 297
Authors: Louise Spence
Categories: Performing Arts
Type: BOOK - Published: 2011 - Publisher: Rutgers University Press

GET EBOOK

Introduction -- Authenticity -- Evidence -- Authority -- Responsibility -- Argument -- Dramatic stories, poetic and essay documentaries -- Editing -- Camerawork