CHAPTER 1 Understanding the Reader

_A month before the launch of the Corg.ly application
The Curse of Knowledge
_User Drawing
_Verify user understanding
_Compressing user survey results
_Creating a friction log
_summation

CHAPTER 2: PLANNING DOCUMENTATION

Creating a _Corg.ly Application Documentation Plan
_Documentation Plans and Patterns
_Content Type
_summation

CHAPTER 3 Creating a Document Draft

_First draft of the Corg.ly application
_Facing a blank page (screen)
_Preparing for successful document writing
_Write an outline
_Write a draft
_Writing documents with skimming in mind
_Getting out when stuck
_Start writing with a template
_Completing the first draft
_summation

CHAPTER 4 Editing Documents

Editing the _Corg.ly application content
_Edit to suit your needs
_Different Approaches to Editing
_Creating an editing process
_Receive feedback and reflect it
_Provide good feedback
_summation

CHAPTER 5 Integrating Sample Code

_Show how the Corg.ly application works
_Using sample code
_Types of sample code
_Principles of Good Sample Code
_Designing sample code
_Tools for sample code
_summation

CHAPTER 6 Adding Visual Content

_Corg.ly application is worth a thousand words…
_When words are not enough
Why Creating Visual Content Is Difficult
_Using screenshots
_Common diagram types
_Drawing a diagram
_Creating video content
_Reviewing visual content
_Maintaining visual content
_summation

CHAPTER 7 Distributing Documents

_Distribute the Corg.ly application!
_Showcasing content
_Building a Content Release Process
_Creating a distribution timeline
_Preparing for the future
_summation

CHAPTER 8: Collecting and Integrating Feedback

_Corg.ly application first feedback
_Listen to user feedback
_Create a feedback channel
_Take action on feedback
_summation

CHAPTER 9 Measuring Document Quality

_Corg.ly application launches next Tuesday
_Is the document I wrote okay?
_Understanding Document Quality
_Developing a strategy for analysis
_Tips for using document metrics
_summation

CHAPTER 10 Structuring Documents

_Corg.ly application next release
_Structuring Documents for Readers
_Helping readers find their way
_Structuring your document
_summation

CHAPTER 11 Discontinuing Document Maintenance and Support

After several releases of the _Corg.ly application
_Keep your documentation up to date
_Planning for Maintenance
_Automating Document Maintenance
_Removing content from a document set
_summation

Appendix A.
What about domestic technical writing?
Appendix B.
When to hire a professional
Appendix C.
References

Special Appendix: Interviews with 11 Domestic Technical Writers

"If you keep writing, you'll get better at it."
- Yoo Young-kyung's "Elegant Brothers"

Technical Writers: People responsible for technical documentation
- Kim Yu-ri, Kakao Enterprise

The Story of an Astrophysics PhD Who Became an AWS Machine Learning Technical Writer
- Choi Mi-young, AWS

"The Story of a Second-Generation Technical Writer"
- Jeon Jeong-eun 〈LINE Plus〉

"The Attitude a Technical Writer Should Have"
- Lim Geun-hee, Coupang

Technical Writer as a Profession
- Park Seon-young, NHN Cloud

What a Technical Writer Does at LINE
- Lee In-sil 〈LINE Plus〉

"The Technical Writer's Attitude"
- Nam Jeong-hyeon (Devsisters)

"Experiences and Brief Reflections of an IT Company Technical Writer"
- Kang Jeong-il (LINE Plus)

"A Technical Writer's Story"
- Lee Jung-min (Netmarble)

"A technical writer is just another common colleague."
- Jo Byeong-seung (Netmarble)

Technical Documentation: A Story for Everyone in the Development Ecosystem

It is important to integrate good documentation and programming.
A well-documented project benefits both developers and users.
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.
Good documentation is essential for project progress.


This book describes the process of creating developer documentation as a hypothetical software development team works through the process of launching a new product.
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.
We also provide practical advice on maintaining your documentation as it grows, including collecting feedback and measuring its effectiveness after deployment.


Additionally, 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.

Target audience

- Software developers who need to write documentation along with code
- Product managers and developer relations managers who need to understand the overall product and service
- Technical blog operators who want to share their development experience or knowledge
- Technical writers who write documentation about products and services
- Outsourced developer who needs to write SI proposal

What this book covers

- Create friction logs and conduct user research to understand user needs.
- Research, draft, and write final content for various types of documentation, including READMEs, API documentation, tutorials, concept documents, and release notes.
- After document distribution, we maintain the quality of the content through user feedback.

- Follow the project process and organize the tasks to be done step by step.