# 토스, 테크니컬 라이팅 가이드 공개

> Clean Markdown view of GeekNews topic #20523. Use the original source for factual precision when an external source URL is present.

## Metadata

- GeekNews HTML: [https://news.hada.io/topic?id=20523](https://news.hada.io/topic?id=20523)
- GeekNews Markdown: [https://news.hada.io/topic/20523.md](https://news.hada.io/topic/20523.md)
- Type: news
- Author: [raon0211](https://news.hada.io/@raon0211)
- Published: 2025-04-25T11:16:52+09:00
- Updated: 2025-04-25T11:16:52+09:00
- Original source: [technical-writing.dev](https://technical-writing.dev/)
- Points: 57
- Comments: 6

## Summary

**토스**는 **기술 문서 작성**의 핵심 원칙을 공개했습니다. 문서의 목적에 따라 **학습 중심**, **문제 해결**, **참조**, **설명 문서**로 구분하여 작성 방법을 달리해야 합니다. **정보 구조화**를 통해 독자의 이해를 돕고, **문장의 전달력**을 높여 내용을 쉽게 이해할 수 있도록 해야 합니다. 이를 위해 문장의 주체를 명확히 하고, 필요한 정보만 남기며, **자연스러운 표현**을 사용해야 합니다.

## Topic Body

### 좋은 기술 문서를 쓰는 핵심 원칙  
  
#### 1. 문서 유형 정하기  
  
문서의 목적에 따라 더 효과적으로 글을 쓰는 방법이 다름  
  
- 학습 중심 문서: 새로운 기술이나 도구를 처음 접했을 때, 흐름을 파악하는 목적  
- 문제 해결 문서: 배경 지식이 있을 때 특정한 문제를 해결하는 목적  
- 참조 문서: 이미 사용 방법을 알지만, 특정 기능이나 API 사용법을 확인하는 목적  
- 설명 문서: 개념, 원리, 배경 지식을 자세히 이해하는 목적  
  
#### 2. 정보 구조 만들기  
  
새로운 지식을 이해하려면 노력이 필요하지만, 정보를 구조화하면 노력을 덜 들일 수 있음  
  
- 한 페이지에서 하나만 다루기  
- 가치를 먼저 제공하기  
- 효과적인 제목 쓰기  
- 개요 빠뜨리지 않기  
- 예측 가능하게 하기  
  
#### 3. 문장 다듬기  
  
문장의 전달력을 높이면 독자가 내용을 더 쉽게 이해할 수 있음. 세부 내용이 이해하기 어려운 문장으로 표현되면 전달력이 많이 떨어짐  
  
- 문장의 주체를 분명하게 하기  
- 필요한 정보만 남기기  
- 구체적으로 쓰기  
- 자연스러운 한국어 표현 쓰기  
- 일관되게 쓰기

## Comments



### Comment 37950

- Author: tested
- Created: 2025-04-29T10:38:58+09:00
- Points: 1

토스에서 만든 이런 사이트들 모아놓은 곳은 없나요?

### Comment 37829

- Author: dontdieych
- Created: 2025-04-26T09:34:24+09:00
- Points: 1

'요'체는 적응하기 힘드네요.

### Comment 37856

- Author: gera1d
- Created: 2025-04-26T16:15:33+09:00
- Points: 2
- Parent comment: 37829
- Depth: 1

맞는 말씀이에요.

### Comment 37800

- Author: winterjung
- Created: 2025-04-25T13:03:37+09:00
- Points: 1

좋네요 특히 문장다듬기 내용은 few shot으로 gpts로 만들어 써봐야겠어요

### Comment 37798

- Author: mathgig
- Created: 2025-04-25T12:28:33+09:00
- Points: 1

이런 글은 좋은 것 같습니다. LLM 시대에는 이런 가이드라인이 어떻게 변형될 수 있을까요?

### Comment 37792

- Author: bluejoyq
- Created: 2025-04-25T11:25:22+09:00
- Points: 1

너무 좋은 프로젝트네요 ^^
