Sign-In
Cart
Crafting Docs for Success: An End-To-End Approach to Developer Documentation
Paperback
Series: Design Thinking
Publisher Price: $44.99
ISBN13: 9781484295939
Publisher: Apress
Published: Sep 29 2023
Pages: 211
Weight: 0.73
Height: 0.49 Width: 6.14 Depth: 9.21
Language: English
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 LearnExamine 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
Software developersand designers, documentation maintainers and managers, technical writers, developer relations practitioners and advocates, technical community managers, developer marketers, and start-up founders, CTOs, and CEOs
Also in
Programming
Interactive Theorem Proving and Program Development: Coq'art: The Calculus of Inductive Constructions
Castéran, Pierre
Bertot, Yves
Hardcover
Seven Databases in Seven Weeks: A Guide to Modern Databases and the Nosql Movement
Perkins, Luc
Redmond, Eric
Wilson, Jim
Paperback
The Legend of Zelda(tm) Tears of the Kingdom - The Complete Official Guide: Collector's Edition
Piggyback
Hardcover
Python Crash Course, 3rd Edition: A Hands-On, Project-Based Introduction to Programming
Matthes, Eric
Paperback
Crisis Engineering: Time-Tested Tools for Turning Chaos Into Clarity
Dickerson, Mikey
Nitze, Marina
Weaver, Matthew
Paperback
Vibe Coding: Building Production-Grade Software with Genai, Chat, Agents, and Beyond
Yegge, Steve
Kim, Gene
Paperback
Accelerate: The Science of Lean Software and DevOps: Building and Scaling High Performing Technology Organizations
Kim, Gene
Forsgren Phd, Nicole
Humble, Jez
Paperback
Embedded Systems with ARM Cortex-M Microcontrollers in Assembly Language and C: Fourth Edition
Zhu, Yifeng
Paperback
The Legend of Zelda(tm) Tears of the Kingdom - The Complete Official Guide: Standard Edition
Piggyback
Paperback
I Have an App Idea: The Essential Guide to Building an App Without Tech Skills
Spann, Amanda
Paperback
Fundamentals of Software Architecture: A Modern Engineering Approach
Richards, Mark
Ford, Neal
Paperback
AI Projects with Raspberry Pi: High-Performance Artificial Intelligence for Robotics, Security, Home Automation, and Vision
Jepson, Brian
Hattersley, Lucy
Paperback
The Manager's Path: A Guide for Tech Leaders Navigating Growth and Change
Fournier, Camille
Paperback
Make: Electronics: Learning by Discovery: A Hands-On Primer for the New Electronics Enthusiast
Platt, Charles
Paperback
The Devops Handbook, 2nd Edition: How to Create World-Class Agility, Reliability, & Security in Technology Organizations
Debois, Patrick
Kim, Gene
Humble, Jez
Paperback
Building Applications with AI Agents: Designing and Implementing Multiagent Systems
Albada, Michael
Paperback
The Developer's Guide to AI: A Field Guide for the Working Developer
Orshalick, Jacob
Reghunadh, Jerry M.
Thompson, Danny
Paperback
Cracking the Coding Interview: 189 Programming Questions and Solutions
McDowell, Gayle Laakmann
Paperback
The New AI Cold War: Liberty vs. Tyranny in the Age of Machine Empires
Maginnis, Ltc Robert L.
Paperback
Learning Web Design: A Beginner's Guide to Html, Css, Javascript, and Web Images
Robbins, Jennifer
Paperback
The Staff Engineer's Path: A Guide for Individual Contributors Navigating Growth and Change
Reilly, Tanya
Paperback
Software Architecture: The Hard Parts: Modern Trade-Off Analyses for Distributed Architectures
Sadalage, Pramod
Ford, Neal
Richards, Mark
Paperback
The Official Raspberry Pi Handbook 2026: Astounding Projects with Raspberry Pi Computers
Makers of Raspberry Pi Official Magazine, The
Paperback
Linux Basics for Hackers, 2nd Edition: Getting Started with Networking, Scripting, and Security in Kali
Occupytheweb
Paperback
SQL QuickStart Guide: The Simplified Beginner's Guide to Managing, Analyzing, and Manipulating Data With SQL
Shields, Walter
Hardcover
The Pragmatic Programmer: Your Journey to Mastery, 20th Anniversary Edition
Thomas, David
Hunt, Andrew
Hardcover
Generative AI Design Patterns: Solutions to Common Challenges When Building Genai Agents and Applications
Hapke, Hannes
Lakshmanan, Valliappa
Paperback
Forecasting: Principles and Practice, the Pythonic Way
Athanasopoulos, George
Hyndman, Rob J.
Paperback
Observability Engineering: Achieving Production Excellence
Fong-Jones, Liz
Miranda, George
Majors, Charity
Paperback
Head First Design Patterns: Building Extensible and Maintainable Object-Oriented Software
Robson, Elisabeth
Freeman, Eric
Paperback
Frictionless: 7 Steps to Remove Barriers, Unlock Value, and Outpace Your Competition in the AI Era
Forsgren, Nicole
Noda, Abi
Paperback
The Return on AI: From Promise to Profit in the Age of Intelligent Business
Mittal, Ashwin
Sawhney, Mohanbir
Paperback
Arduino Programming for Beginners: A Comprehensive Beginner's Guide to Learn the Realms of Arduino Programming from A-Z
Protosmith, Ada
Paperback
Building AI-Powered Products: The Essential Guide to AI and Genai Product Management
Nika, Marily
Paperback
Grokking Algorithms, Second Edition: An Illustrated Guide for Programmers and Other Curious People
Bhargava, Aditya Y.
Paperback
Concrete Mathematics: A Foundation for Computer Science
Patashnik, Oren
Knuth, Donald
Graham, Ronald
Hardcover
Debugging: The 9 Indispensable Rules for Finding Even the Most Elusive Software and Hardware Problems
Agans, David J.
Paperback
Learning Generative AI Tools for Excel: Speed Up Your Everyday Tasks with Microsoft Excel, Copilot, Chatgpt, and Beyond
Duca, Angelica Lo
Paperback
Learning Domain-Driven Design: Aligning Software Architecture and Business Strategy
Khononov, Vlad
Paperback
This Is Service Design Doing: Applying Service Design Thinking in the Real World
Lawrence, Adam
Hormess, Markus Edgar
Stickdorn, Marc
Paperback
The Software Architect Elevator: Redefining the Architect's Role in the Digital Enterprise
Hohpe, Gregor
Paperback
Computer Science from Scratch: Building Interpreters, Art, Emulators and ML in Python
Kopec, David
Paperback
Python Programming for Young Coders: A Hands-On, Project-Based Introduction to Coding for Beginners, Kids, and Teens
Pandey, Anand
Paperback
Learning Php, MySQL & JavaScript: A Step-By-Step Guide to Creating Dynamic Websites
Nixon, Robin
Paperback
Software Engineering at Google: Lessons Learned from Programming Over Time
Manshreck, Tom
Wright, Hyrum
Winters, Titus
Paperback
Prompt Engineering for Llms: The Art and Science of Building Large Language Model-Based Applications
Berryman, John
Ziegler, Albert
Paperback
Living a Jewish Life, Revised and Updated: Jewish Traditions, Customs, and Values for Today's Families
Cooper, Howard
Diamant, Anita
Paperback
Articulating Design Decisions: Communicate with Stakeholders, Keep Your Sanity, and Deliver the Best User Experience
Greever, Tom
Paperback
Pro C# 10 with .Net 6: Foundational Principles and Practices in Programming
Troelsen, Andrew
Japikse, Phil
Paperback
Adobe Photoshop, 2nd Edition: A Complete Course and Compendium of Features
Laskevitch, Stephen
Paperback
Kubernetes in Action, Second Edition: Deploying and Managing Containers and Cloud-Native Applications
Luksa, Marko
Conner, Kevin
Paperback
Spies, Lies, and Algorithms: The History and Future of American Intelligence
Zegart, Amy B.
Paperback
Site Reliability Engineering: How Google Runs Production Systems
Murphy, Niall Richard
Jones, Chris
Beyer, Betsy
Paperback
Ruined by Design: How Designers Destroyed the World, and What We Can Do to Fix It
Monteiro, Mike
Paperback
Electronic Music and Sound Design - Theory and Practice with Max 9 - Volume 1 (Fifth Edition)
Maurizio, Giri
Cipriani, Alessandro
Paperback