Crafting Docs for Success: An End-to-End Approach to Developer Documentation
Crafting Docs for Success: An End-to-End Approach to Developer Documentation
YOU SAVE £6.88
- Condition: Brand new
- UK Delivery times: Usually arrives within 2 - 3 working days
- UK Shipping: Fee starts at £2.39. Subject to product weight & dimension
- More about Crafting Docs for Success: An End-to-End Approach to Developer Documentation
Developer documentation is essential for developer relations, providing information during onboarding and changes. This book offers a blueprint for building successful documentation using the award-winning platformOS developer portal as inspiration, covering topics such as targeting the right audience, designing a seamless onboarding experience, and selecting workflows and data analysis methods. It also empowers teams and communities to contribute and maintain documentation, improving diversity and inclusion.
Format: Paperback / softback
Length: 211 pages
Publication date: 29 September 2023
Publisher: APress
Developer documentation is a vital tool in developer relations, providing essential information during the onboarding process and keeping users informed of changes such as release notes, status reports, and new topics. This book aims to provide a comprehensive guide to building successful developer documentation using the award-winning platformOS developer portal as inspiration.
Using a design thinking approach, the book offers practical, usable templates, workflows, and tools validated and peer-reviewed by international experts in documentation, technical writing, developer relations, and UX design. It delves into the many factors that must be considered while crafting developer documentation, such as targeting the right audience, designing a seamless onboarding experience, and selecting the appropriate workflows and data analysis methods.
The book explores this complex mix of topics, each with its unique considerations, and explains why it can be difficult for those working on developer documentation to understand the process and gather all the necessary ingredients, tools, and resources. It provides a comprehensive roadmap for empowering teams and communities to contribute and maintain documentation, while also promoting diversity and inclusion.
Crafting Docs for Success is a comprehensive resource for developers, technical writers, and anyone involved in creating effective developer documentation. It covers topics such as user research, design thinking, community-driven documentation, editorial workflows, style guides, and technical implementation. Whether you are a seasoned developer or just starting in the field, this book will help you build and maintain high-quality developer documentation that enhances the user experience and drives engagement.
Weight: 361g
Dimension: 235 x 155 (mm)
ISBN-13: 9781484295939
Edition number: 1st ed.
This item can be found in:
UK and International shipping information
UK and International shipping information
UK Delivery and returns information:
- Delivery within 2 - 3 days when ordering in the UK.
- Shipping fee for UK customers from £2.39. Fully tracked shipping service available.
- Returns policy: Return within 30 days of receipt for full refund.
International deliveries:
Shulph Ink now ships to Australia, Belgium, Canada, France, Germany, Ireland, Italy, India, Luxembourg Saudi Arabia, Singapore, Spain, Netherlands, New Zealand, United Arab Emirates, United States of America.
- Delivery times: within 5 - 10 days for international orders.
- Shipping fee: charges vary for overseas orders. Only tracked services are available for most international orders. Some countries have untracked shipping options.
- Customs charges: If ordering to addresses outside the United Kingdom, you may or may not incur additional customs and duties fees during local delivery.