{"product_id":"110512","title":"Docs for Developers: The Complete Guide to Writing Technical Documentation ","description":"\u003ccenter\u003e\u003cdiv style=\"text-align:center\"\u003e\u003cimg src=\"https:\/\/tmgdisk01.cafe24.com\/images\/vs\/4172\/sv\/3jYEEOD7fVUh1X6w4ov0810DRGMUoU.png?v=1765104716\" style=\"max-width:100%;max-height:10px\"\u003e\u003c\/div\u003e\u003c\/center\u003e\n\u003ccenter\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd style=\"height:10px\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\u003c\/table\u003e\u003c\/center\u003e\n\u003ccenter\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd style=\"height:10px\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\u003c\/table\u003e\u003c\/center\u003e\n\u003ccenter\u003e\n\n\u003cdiv style=\"width:95%\"\u003e\n\n\u003cdiv style=\"text-align:center;font-size:30px;font-weight:bolder;line-height:1.6em\"\u003e Docs for Developers: The Complete Guide to Writing Technical Documentation \u003c\/div\u003e\n\n\u003ccenter\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd style=\"height:10px\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\u003c\/table\u003e\u003c\/center\u003e\n\n\u003ccenter\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd style=\"height:10px\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\u003c\/table\u003e\u003c\/center\u003e\n\n\u003ccenter\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd style=\"height:10px\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\u003c\/table\u003e\u003c\/center\u003e\n\n\u003ccenter\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd style=\"height:10px\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\u003c\/table\u003e\u003c\/center\u003e\n\n\u003cdiv style=\"border-bottom:1px;border-bottom-style:dotted;border-color:;padding-bottom:20px\"\u003e\u003ccenter\u003e\u003ctable align=\"center\" width=\"100%\"\u003e\u003ctbody style=\"border:0px\"\u003e\n\n\u003ctr\u003e\u003ctd align=\"center\" style=\"line-height:1.2em;text-align:center;font-size:18px;color:black;font-weight:bold;padding-bottom:20px;\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\n\n\u003ctr\u003e\u003ctd style=\"text-align:center\"\u003e\u003cimg src=\"https:\/\/image.yes24.com\/goods\/118266847\/XL\" style=\"max-width:100%;height:auto\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\n\n\n\u003c\/tbody\u003e\u003c\/table\u003e\u003c\/center\u003e\u003c\/div\u003e\n\n\u003ccenter\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd style=\"height:10px\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\u003c\/table\u003e\u003c\/center\u003e\n\n\u003ccenter\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd style=\"height:10px\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\u003c\/table\u003e\u003c\/center\u003e\n\n\u003cdiv style=\"width:95%;{split_style6}padding-top:20px;padding-bottom:20px\"\u003e\n\n\u003cdiv style=\"text-align:left;font-size:16px;font-weight:bold;padding-bottom:20px\"\u003e Description \u003c\/div\u003e\n\n\u003cdiv style=\"text-align:left;word-break:break-all;font-size:14px;line-height:1.6em;\"\u003e\n\n\u003cdiv\u003e\u003ch5\u003e \u003cb\u003eBook Introduction\u003c\/b\u003e\n\u003c\/h5\u003e\u003c\/div\u003e\n\u003cdiv\u003e\n\u003cdiv\u003e\u003cdiv\u003e \u003cb\u003ePractical Notes for Technical Writing: A Guide for Software Developers\u003cbr\u003e Woowa Brothers, Kakao, AWS, LINE Plus, Coupang, NHN, Devsisters, Netmarble, etc.\u003cbr\u003e Special interviews with 11 domestic technical writers!\u003c\/b\u003e\u003cbr\u003e\u003cbr\u003e This book follows the story of the development team that created the 'Dog Voice Translation Service' and is structured to teach you step-by-step the process of creating development documentation.\u003cbr\u003e Through step-by-step examples, templates, and guides, you'll learn not only the theoretical content but also how to effectively create and manage documents. \u003cbr\u003eLearn step-by-step documentation techniques and cover the entire project management and software development lifecycle—from understanding user needs to writing documentation, distributing, and maintaining useful developer documentation—all in one book.\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e Additionally, the appendix includes interviews with 11 renowned technical writers from Korea who work at Woowa Brothers, LINE Plus, Kakao Enterprise, NHN Cloud, Netmarble, Devsisters, AWS, and Coupang.\u003cbr\u003e Explains what technical writing is and the role of technical writers in the industry.\u003cbr\u003e You can hear various experiences and stories from seniors who have already experienced the world of technical writing.\u003cbr\u003e\n\n\u003c\/div\u003e\u003c\/div\u003e\n\u003cdiv\u003e\u003cul\u003e\u003cli\u003e You can preview some of the book's contents.\u003cbr\u003e \u003cspan\u003ePreview\u003c\/span\u003e\n\n\u003c\/li\u003e\u003c\/ul\u003e\u003c\/div\u003e\n\u003c\/div\u003e\n\u003cbr\u003e\u003cdiv\u003e\u003ch5\u003e \u003cb\u003eindex\u003c\/b\u003e\n\u003c\/h5\u003e\u003c\/div\u003e\n\u003cdiv\u003e\n\u003cdiv\u003e \u003cb\u003eCHAPTER 1 Understanding the Reader\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e _A month before the launch of the Corg.ly application\u003cbr\u003e The Curse of Knowledge\u003cbr\u003e _User Drawing\u003cbr\u003e _Verify user understanding  \u003cbr\u003e_Compressing user survey results\u003cbr\u003e _Creating a friction log\u003cbr\u003e _summation\u003cbr\u003e\u003cbr\u003e \u003cb\u003eCHAPTER 2: PLANNING DOCUMENTATION\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e Creating a _Corg.ly Application Documentation Plan\u003cbr\u003e _Documentation Plans and Patterns\u003cbr\u003e _Content Type\u003cbr\u003e _summation\u003cbr\u003e\u003cbr\u003e \u003cb\u003eCHAPTER 3 Creating a Document Draft\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e _First draft of the Corg.ly application\u003cbr\u003e _Facing a blank page (screen)\u003cbr\u003e _Preparing for successful document writing\u003cbr\u003e _Write an outline\u003cbr\u003e _Write a draft\u003cbr\u003e _Writing documents with skimming in mind\u003cbr\u003e _Getting out when stuck\u003cbr\u003e _Start writing with a template\u003cbr\u003e _Completing the first draft\u003cbr\u003e _summation\u003cbr\u003e\u003cbr\u003e \u003cb\u003eCHAPTER 4 Editing Documents\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e Editing the _Corg.ly application content\u003cbr\u003e _Edit to suit your needs\u003cbr\u003e _Different Approaches to Editing\u003cbr\u003e _Creating an editing process\u003cbr\u003e _Receive feedback and reflect it\u003cbr\u003e _Provide good feedback\u003cbr\u003e _summation\u003cbr\u003e\u003cbr\u003e \u003cb\u003eCHAPTER 5 Integrating Sample Code\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e _Show how the Corg.ly application works\u003cbr\u003e _Using sample code  \u003cbr\u003e_Types of sample code\u003cbr\u003e _Principles of Good Sample Code\u003cbr\u003e _Designing sample code\u003cbr\u003e _Tools for sample code\u003cbr\u003e _summation\u003cbr\u003e\u003cbr\u003e \u003cb\u003eCHAPTER 6 Adding Visual Content\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e _Corg.ly application is worth a thousand words…\u003cbr\u003e _When words are not enough\u003cbr\u003e Why Creating Visual Content Is Difficult\u003cbr\u003e _Using screenshots\u003cbr\u003e _Common diagram types\u003cbr\u003e _Drawing a diagram\u003cbr\u003e _Creating video content\u003cbr\u003e _Reviewing visual content\u003cbr\u003e _Maintaining visual content\u003cbr\u003e _summation\u003cbr\u003e\u003cbr\u003e \u003cb\u003eCHAPTER 7 Distributing Documents\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e _Distribute the Corg.ly application!\u003cbr\u003e _Showcasing content\u003cbr\u003e _Building a Content Release Process\u003cbr\u003e _Creating a distribution timeline\u003cbr\u003e _Preparing for the future\u003cbr\u003e _summation\u003cbr\u003e\u003cbr\u003e \u003cb\u003eCHAPTER 8: Collecting and Integrating Feedback\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e _Corg.ly application first feedback\u003cbr\u003e _Listen to user feedback\u003cbr\u003e _Create a feedback channel\u003cbr\u003e _Take action on feedback\u003cbr\u003e _summation\u003cbr\u003e\u003cbr\u003e \u003cb\u003eCHAPTER 9 Measuring Document Quality\u003cbr\u003e\u003c\/b\u003e \u003cbr\u003e_Corg.ly application launches next Tuesday\u003cbr\u003e _Is the document I wrote okay?\u003cbr\u003e _Understanding Document Quality\u003cbr\u003e _Developing a strategy for analysis\u003cbr\u003e _Tips for using document metrics\u003cbr\u003e _summation\u003cbr\u003e\u003cbr\u003e \u003cb\u003eCHAPTER 10 Structuring Documents\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e _Corg.ly application next release\u003cbr\u003e _Structuring Documents for Readers\u003cbr\u003e _Helping readers find their way\u003cbr\u003e _Structuring your document\u003cbr\u003e _summation\u003cbr\u003e\u003cbr\u003e \u003cb\u003eCHAPTER 11 Discontinuing Document Maintenance and Support\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e After several releases of the _Corg.ly application\u003cbr\u003e _Keep your documentation up to date\u003cbr\u003e _Planning for Maintenance\u003cbr\u003e _Automating Document Maintenance\u003cbr\u003e _Removing content from a document set\u003cbr\u003e _summation\u003cbr\u003e\u003cbr\u003e Appendix A.\u003cbr\u003e What about domestic technical writing?\u003cbr\u003e Appendix B.\u003cbr\u003e When to hire a professional\u003cbr\u003e Appendix C.\u003cbr\u003e References\u003c\/div\u003e\n\u003cdiv\u003e\u003c\/div\u003e\n\u003c\/div\u003e\n\u003cbr\u003e\u003cdiv\u003e\u003ch5\u003e \u003cb\u003eDetailed image\u003c\/b\u003e \u003c\/h5\u003e\u003c\/div\u003e\n\u003cdiv\u003e\u003cdiv\u003e\u003cimg src=\"https:\/\/image.yes24.com\/momo\/TopCate4146\/MidCate002\/414511698.JPG\" border=\"0\" alt=\"Detailed Image 1\"\u003e\u003c\/div\u003e\u003c\/div\u003e\n\u003cbr\u003e\u003cdiv\u003e\u003ch5\u003e \u003cb\u003ePublisher's Review\u003c\/b\u003e\n\u003c\/h5\u003e\u003c\/div\u003e\n\u003cdiv\u003e\n\u003cdiv\u003e \u003cb\u003eSpecial Appendix: Interviews with 11 Domestic Technical Writers\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e \"If you keep writing, you'll get better at it.\"\u003cbr\u003e - Yoo Young-kyung's \"Elegant Brothers\"\u003cbr\u003e \u003cbr\u003eTechnical Writers: People responsible for technical documentation\u003cbr\u003e - Kim Yu-ri, Kakao Enterprise\u003cbr\u003e\u003cbr\u003e The Story of an Astrophysics PhD Who Became an AWS Machine Learning Technical Writer\u003cbr\u003e - Choi Mi-young, AWS\u003cbr\u003e\u003cbr\u003e \"The Story of a Second-Generation Technical Writer\"\u003cbr\u003e - Jeon Jeong-eun 〈LINE Plus〉\u003cbr\u003e\u003cbr\u003e \"The Attitude a Technical Writer Should Have\"\u003cbr\u003e - Lim Geun-hee, Coupang\u003cbr\u003e\u003cbr\u003e Technical Writer as a Profession\u003cbr\u003e - Park Seon-young, NHN Cloud\u003cbr\u003e\u003cbr\u003e What a Technical Writer Does at LINE\u003cbr\u003e - Lee In-sil 〈LINE Plus〉\u003cbr\u003e\u003cbr\u003e \"The Technical Writer's Attitude\"\u003cbr\u003e - Nam Jeong-hyeon (Devsisters)\u003cbr\u003e\u003cbr\u003e \"Experiences and Brief Reflections of an IT Company Technical Writer\"\u003cbr\u003e - Kang Jeong-il (LINE Plus)\u003cbr\u003e\u003cbr\u003e \"A Technical Writer's Story\"\u003cbr\u003e - Lee Jung-min (Netmarble)\u003cbr\u003e\u003cbr\u003e \"A technical writer is just another common colleague.\"\u003cbr\u003e - Jo Byeong-seung (Netmarble)\u003cbr\u003e\u003cbr\u003e \u003cb\u003eTechnical Documentation: A Story for Everyone in the Development Ecosystem\u003cbr\u003e\u003c\/b\u003e \u003cbr\u003eIt is important to integrate good documentation and programming.\u003cbr\u003e A well-documented project benefits both developers and users.\u003cbr\u003e Projects without adequate technical documentation not only suffer from reduced developer productivity, project scalability, user adoption and accessibility, but also lower the likelihood of project success.\u003cbr\u003e Good documentation is essential for project progress.\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e This book describes the process of creating developer documentation as a hypothetical software development team works through the process of launching a new product.\u003cbr\u003e We'll guide you through the process, from researching your users' needs and planning to drafting and editing content and distribution, following common documentation patterns.\u003cbr\u003e We also provide practical advice on maintaining your documentation as it grows, including collecting feedback and measuring its effectiveness after deployment.\u003cbr\u003e\u003cbr\u003e \u003cbr\u003eAdditionally, we've included interviews with 11 renowned technical writers in Korea that weren't included in the original book, offering stories about the work of technical writers working at various companies, as well as helpful stories from our own experiences as senior technical writers.\u003cbr\u003e\u003cbr\u003e \u003cb\u003eTarget audience\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e - Software developers who need to write documentation along with code\u003cbr\u003e - Product managers and developer relations managers who need to understand the overall product and service\u003cbr\u003e - Technical blog operators who want to share their development experience or knowledge\u003cbr\u003e - Technical writers who write documentation about products and services\u003cbr\u003e - Outsourced developer who needs to write SI proposal\u003cbr\u003e\u003cbr\u003e \u003cb\u003eWhat this book covers\u003cbr\u003e\u003c\/b\u003e\u003cbr\u003e - Create friction logs and conduct user research to understand user needs. \u003cbr\u003e- Research, draft, and write final content for various types of documentation, including READMEs, API documentation, tutorials, concept documents, and release notes.\u003cbr\u003e - After document distribution, we maintain the quality of the content through user feedback.\u003cbr\u003e\u003cbr\u003e - Follow the project process and organize the tasks to be done step by step. \u003cbr\u003e\n\n\u003c\/div\u003e\n\u003cdiv\u003e\u003c\/div\u003e\n\u003c\/div\u003e\n\u003c\/div\u003e\n\n\n\u003c\/div\u003e\n\n\u003ccenter\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd style=\"height:10px\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\u003c\/table\u003e\u003c\/center\u003e\n\n\u003ccenter\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd style=\"height:10px\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\u003c\/table\u003e\u003c\/center\u003e\n\n\u003cdiv style=\"width:95%;padding-top:20px;padding-bottom:20px\"\u003e\n\n\u003cdiv style=\"text-align:left;font-size:16px;font-weight:bold;padding-bottom:20px\"\u003e GOODS SPECIFICS \u003c\/div\u003e\n\n\u003cdiv style=\"text-align:left;font-size:14px;line-height:1.6em;\"\u003e\n\n\u003cdiv style=\"width:100%;margin-bottom:5px;line-height:1.6em;font-size:14px\"\u003e - \u003cstrong\u003eDate of issue:\u003c\/strong\u003e April 10, 2023\u003c\/div\u003e\n\n\u003cdiv style=\"width:100%;margin-bottom:5px;line-height:1.6em;font-size:14px\"\u003e - \u003cstrong\u003ePage count, weight, size:\u003c\/strong\u003e 332 pages | 486g | 153*223*12mm\u003c\/div\u003e\n\n\u003cdiv style=\"width:100%;margin-bottom:5px;line-height:1.6em;font-size:14px\"\u003e - \u003cstrong\u003eISBN13:\u003c\/strong\u003e 9791169210881\u003c\/div\u003e\n\n\u003cdiv style=\"width:100%;margin-bottom:5px;line-height:1.6em;font-size:14px\"\u003e - \u003cstrong\u003eISBN10:\u003c\/strong\u003e 1169210880 \u003c\/div\u003e\n\n\n\u003c\/div\u003e\n\n\n\u003c\/div\u003e\n\n\n\u003c\/div\u003e\n\n\u003ccenter\u003e\n\n\u003ccenter\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd style=\"height:10px\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\u003c\/table\u003e\u003c\/center\u003e\n\n\u003ccenter\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd style=\"height:10px\"\u003e\u003c\/td\u003e\u003c\/tr\u003e\u003c\/table\u003e\u003c\/center\u003e\n\n\u003cspan\u003e\u003c\/span\u003e\n\n\u003c\/center\u003e\n\n\n\u003c\/center\u003e","brand":"LIBRAIRIE COREENNE","offers":[{"title":"Default Title","offer_id":43893823307818,"sku":"110512","price":31.0,"currency_code":"EUR","in_stock":true}],"thumbnail_url":"\/\/cdn.shopify.com\/s\/files\/1\/0683\/2750\/5962\/files\/8253cd9bb312338a678bebdf350a1dc9.jpg?v=1765418913","url":"https:\/\/librairie.coreenne.fr\/en\/products\/110512","provider":"LIBRAIRIE COREENNE","version":"1.0","type":"link"}