Docs for Developers: An Engineer's Field Guide to Technical Writing
暫譯: 開發者文檔：工程師的技術寫作實用指南
Bhatti, Jared, Corleissen, Zachary Sarah, Lambourne, Jen
- 出版商: Apress
- 出版日期: 2021-10-01
- 售價: $2,040
- 貴賓價: 9.5 折 $1,938
- 語言: 英文
- 頁數: 240
- 裝訂: Quality Paper - also called trade paper
- ISBN: 1484272161
- ISBN-13: 9781484272169
海外代購書籍(需單獨結帳)
買這商品的人也買了...
相關主題
商品描述
Learn to integrate programming with good documentation. This book teaches you the craft of documentation for each step in the software development lifecycle, from understanding your users' needs to publishing, measuring, and maintaining useful developer documentation.
Well-documented projects save time for both developers on the project and users of the software. Projects without adequate documentation suffer from poor developer productivity, project scalability, user adoption, and accessibility. In short: bad documentation kills projects.
Docs for Developers demystifies the process of creating great developer documentation, following a team of software developers as they work to launch a new product. At each step along the way, you learn through examples, templates, and principles how to create, measure, and maintain documentation--tools you can adapt to the needs of your own organization.
What You'll Learn
- Create friction logs and perform user research to understand your users' frustrations
- Research, draft, and write different kinds of documentation, including READMEs, API documentation, tutorials, conceptual content, and release notes
- Publish and maintain documentation alongside regular code releases
- Measure the success of the content you create through analytics and user feedback
- Organize larger sets of documentation to help users find the right information at the right time
Who This Book Is For
Ideal for software developers who need to create documentation alongside code, or for technical writers, developer advocates, product managers, and other technical roles that create and contribute to documentation for their products and services.
商品描述(中文翻譯)
學習如何將程式設計與良好的文件整合。本書教您在軟體開發生命週期中的每個步驟中進行文件編寫的技巧，從了解用戶需求到發佈、測量和維護有用的開發者文件。
良好文件化的專案能為專案中的開發者和軟體使用者節省時間。缺乏充分文件的專案會導致開發者生產力低下、專案可擴展性差、用戶採用率低以及可及性問題。簡而言之：糟糕的文件會毀掉專案。
《Docs for Developers》揭開了創建優秀開發者文件的過程，跟隨一組軟體開發者在推出新產品的過程中。在每個步驟中，您將通過範例、模板和原則學習如何創建、測量和維護文件——這些工具您可以根據自己組織的需求進行調整。
您將學到的內容：
- 創建摩擦日誌並進行用戶研究，以了解用戶的挫折
- 研究、草擬和撰寫不同類型的文件，包括 README、API 文件、教程、概念內容和發佈說明
- 在常規代碼發佈的同時發佈和維護文件
- 通過分析和用戶反饋來衡量您創建內容的成功
- 組織更大範圍的文件，以幫助用戶在正確的時間找到正確的信息
本書適合對象：
本書非常適合需要在編寫代碼的同時創建文件的軟體開發者，或是技術寫作人、開發者倡導者、產品經理及其他創建和貢獻其產品和服務文件的技術角色。
作者簡介
Jared Bhatti
Jared is a Staff Technical Writer at Alphabet, and the co-founder of Google's Cloud documentation team. He's worked for the past 14 years documenting an array of projects at Alphabet, including Kubernetes, App Engine, Adsense, Google's data centers, and Google's environmental sustainability efforts. He currently leads technical documentation at Waymo and mentors several junior writers in the industry.
Zachary Sarah Corleissen
Zach began this book as the Lead Technical Writer for the Linux Foundation and ended it as Stripe's first Staff Technical Writer. Zach served as co-chair for Kubernetes documentation from 2017 until 2021, and has worked on developer docs previously at GitHub, Rackspace, and several startups. They enjoy speaking at conferences and love to mentor writers and speakers of all abilities and backgrounds.
Heidi Waterhouse
Heidi spent a couple decades at Microsoft, Dell Software, and many, many startups learning to communicate with and for developers. She currently works as a principal developer advocate at LaunchDarkly, but was reassured to find that technical communication is universal across all roles.
David Nunez
David heads up the technical writing organization at Stripe, where he founded the internal documentation team and wrote for Increment magazine. Before Stripe, he founded and led the technical writing organization at Uber and held a documentation leadership role at Salesforce. Having led teams that have written about cloud, homegrown infrastructure, self-driving trucks, and economic infrastructure, he's studied the many ways that technical documentation can shape the user experience. David also acts as an advisor for several startups in the knowledge platform space.
Jen Lambourne
Jen leads the technical writing and knowledge management discipline at Monzo Bank. Before her foray into fintech, she led a community of documentarians across the UK government as Head of Technical Writing at the Government Digital Service (GDS). Having moved from government to finance, she recognizes she's drawn to creating inclusive and user-centred content in traditionally unfriendly industries. She likes using developer tools to manage docs, demystifying the writing process for engineers, mentoring junior writers, and presenting her adventures in documentation at conferences.
作者簡介(中文翻譯)
Jared Bhatti
Jared 是 Alphabet 的資深技術寫作專員，也是 Google Cloud 文件團隊的共同創辦人。在過去的 14 年中，他負責記錄 Alphabet 的各種專案，包括 Kubernetes、App Engine、Adsense、Google 的數據中心以及 Google 的環境可持續性努力。他目前在 Waymo 負責技術文件的工作，並指導幾位業界的初級寫作人員。
Zachary Sarah Corleissen
Zach 以 Linux Foundation 的首席技術寫作專員身份開始這本書，並以 Stripe 的首位資深技術寫作專員身份結束。Zach 從 2017 年到 2021 年擔任 Kubernetes 文件的共同主席，並曾在 GitHub、Rackspace 和幾家初創公司工作過開發者文檔。他們喜歡在會議上演講，並熱衷於指導各種能力和背景的寫作人和演講者。
Heidi Waterhouse
Heidi 在 Microsoft、Dell Software 和許多初創公司工作了幾十年，學習如何與開發者溝通並為他們服務。她目前在 LaunchDarkly 擔任首席開發者倡導者，但她感到欣慰的是，技術溝通在所有角色中都是普遍的。
David Nunez
David 負責 Stripe 的技術寫作組織，他創立了內部文件團隊並為 Increment 雜誌撰寫文章。在加入 Stripe 之前，他創立並領導了 Uber 的技術寫作組織，並在 Salesforce 擔任文件領導角色。作為曾經領導撰寫有關雲端、自建基礎設施、自駕卡車和經濟基礎設施的團隊，他研究了技術文件如何塑造用戶體驗的多種方式。David 也擔任幾家知識平台初創公司的顧問。
Jen Lambourne
Jen 在 Monzo Bank 領導技術寫作和知識管理領域。在進入金融科技之前，她擔任英國政府數字服務（GDS）技術寫作負責人，領導一個文件編輯社群。從政府轉向金融行業後，她意識到自己對於在傳統上不友好的行業中創造包容性和以用戶為中心的內容充滿熱情。她喜歡使用開發者工具來管理文檔，為工程師解密寫作過程，指導初級寫作人員，並在會議上分享她在文檔方面的冒險經歷。
