商品描述
Learn 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. This new edition has been fully updated and edited taking into account the needs for developers and tech writers today, with new content relating to AI, automation and LLMs.
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.
You Will Learn to: 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 Understand where (and where not) to integrate AI into your documentation workflow
This Book Is For Developers who need to create documentation alongside code, or for technical writers, product managers, community managers, developer advocates, and other technical roles who create and contribute to documentation. 'This book is like Strunk & White for writing tech docs' --Tom Johnson, Senior Technical Writer, Google 'As AI reshapes how people find and consume information, understanding your users and writing docs that serve them is critical - and Docs for Developers makes that entire process accessible to any team.' --Tal Gluck, Developer Advocate, GitBook and co-author, State of Docs report
商品描述(中文翻譯)
學習在軟體開發生命週期中每個步驟的文檔撰寫技巧，從了解用戶需求到發布、測量和維護有用的開發者文檔。良好文檔的專案能為專案中的開發者和軟體使用者節省時間。缺乏充分文檔的專案會遭遇開發者生產力低下、專案可擴展性差、用戶採用率低和可及性問題。簡而言之：糟糕的文檔會毀掉專案。本新版本已全面更新和編輯，考慮到當今開發者和技術寫作人員的需求，並新增與人工智慧、自动化和大型語言模型（LLMs）相關的內容。
《Docs for Developers》揭開了創建優秀開發者文檔的過程，跟隨一組軟體開發者在推出新產品的過程中。在每個步驟中，您將通過範例、模板和原則學習如何創建、測量和維護文檔——這些工具您可以根據自己組織的需求進行調整。
您將學會：
- 創建摩擦日誌並進行用戶研究，以了解用戶的挫折
- 研究、草擬和撰寫不同類型的文檔，包括 README、API 文檔、教程、概念內容和版本說明
- 在常規代碼發布的同時發布和維護文檔
- 通過分析和用戶反饋來衡量您創建內容的成功
- 組織更大範圍的文檔，以幫助用戶在正確的時間找到正確的信息
- 了解在文檔工作流程中應該（以及不應該）整合人工智慧的地方
本書適合：
需要在編寫代碼的同時創建文檔的開發者，或是技術寫作人員、產品經理、社群經理、開發者倡導者及其他創建和貢獻文檔的技術角色。
「這本書就像 Strunk & White 對於技術文檔寫作的指導。」
——Tom Johnson，Google 高級技術寫作人員
「隨著人工智慧重塑人們尋找和消費信息的方式，了解您的用戶並撰寫能服務於他們的文檔至關重要，而《Docs for Developers》使整個過程對任何團隊都變得可及。」
——Tal Gluck，GitBook 開發者倡導者及《State of Docs》報告的共同作者
作者簡介
Jared Bhatti is Lead Technical Writer for Waymo engineering. Before that, he was the co-founder of Google's Cloud documentation team. He's worked on a variety of projects at Google, including Kubernetes, App Engine, Adsense, Google's data centers, and Google's environmental sustainability efforts. He loves teaching writing and mentors several junior writers in the industry. Sarah Corleissen has worked as a Senior Technical Writer in a variety of organizations focused on cloud native and open source work, including Isovalent, the Linux Foundation, Stripe, and Github. Sarah served as co-chair for Kubernetes documentation from 2017 until 2021. She enjoys speaking at conferences and loves to mentor writers and speakers of all abilities and backgrounds. Jen Lambourne 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. David Nunez is the Co-Founder of Falconer, an AI startup that for creating, maintaining, and finding institutional knowledge. Before that, he led the technical writing organization at Stripe, where he founded the internal documentation team and wrote for Increment magazine. He also founded and led the technical writing organization at Uber and held a documentation leadership role at Salesforce. Heidi Waterhouse spent a couple decades at Microsoft, Dell Software, and many, many startups learning to communicate with and for developers. She's constantly reassured to find that technical communication is universal across all roles. She is also the co-author of Progressive Delivery: Build the Right Thing for the Right People at the Right Time.
作者簡介(中文翻譯)
賈瑞德·巴提 (Jared Bhatti) 是 Waymo 工程部的首席技術寫作專員。在此之前，他是 Google Cloud 文檔團隊的共同創辦人。他在 Google 參與了多個項目，包括 Kubernetes、App Engine、Adsense、Google 的數據中心以及 Google 的環境可持續性努力。他熱愛教學寫作，並指導多位業界的初級寫作者。 莎拉·科雷森 (Sarah Corleissen) 曾在多個專注於雲原生和開源工作的組織中擔任高級技術寫作專員，包括 Isovalent、Linux 基金會、Stripe 和 Github。莎拉從 2017 年到 2021 年擔任 Kubernetes 文檔的共同主席。她喜歡在會議上演講，並熱衷於指導各種能力和背景的寫作者和演講者。 珍·蘭博恩 (Jen Lambourne) 在 Monzo 銀行領導技術寫作和知識管理領域。在進入金融科技之前，她擔任英國政府數字服務 (GDS) 的技術寫作負責人，領導一個由文件製作者組成的社群。從政府轉向金融行業後，她意識到自己對於在傳統上不友好的行業中創造包容性和以用戶為中心的內容充滿熱情。她喜歡使用開發者工具來管理文檔，為工程師解密寫作過程，指導初級寫作者，並在會議上分享她在文檔方面的冒險經歷。 大衛·努涅斯 (David Nunez) 是 Falconer 的共同創辦人，這是一家專注於創建、維護和尋找機構知識的 AI 初創公司。在此之前，他在 Stripe 領導技術寫作組織，創建了內部文檔團隊並為 Increment 雜誌撰寫文章。他還創立並領導了 Uber 的技術寫作組織，並在 Salesforce 擔任文檔領導職位。 海蒂·沃特豪斯 (Heidi Waterhouse) 在 Microsoft、Dell Software 和許多初創公司工作了幾十年，學習如何與開發者進行交流。她不斷得到安慰，發現技術交流在所有角色中都是普遍的。她也是《漸進式交付：為正確的人在正確的時間構建正確的事物》的共同作者。
