알고나면 쓸모있을 지식 보관소

타이프라이터

부록

이 부록은 기술적 글쓰기를 시작하거나 개선하려는 여러분을 위한 실용적인 도구와 자료를 모았습니다. 용어집으로 기본 개념을 익히고, 추천 도서로 깊이를 더하며, 템플릿과 체크리스트로 실전에 바로 적용해보세요.

A. 기술적 글쓰기 용어집

기술적 글쓰기에서 자주 쓰이는 용어를 간단히 정의했습니다.

  • API (Application Programming Interface): 소프트웨어 간 데이터 교환을 위한 규칙과 도구.
  • 다이어그램: 과정, 구조를 시각적으로 보여주는 그림(예: 흐름도).
  • 레이아웃: 문서의 시각적 배치(제목, 여백, 이미지 위치 등).
  • 마크다운 (Markdown): 간단한 형식으로 텍스트를 구조화하는 경량 마크업 언어.
  • 매뉴얼: 제품이나 시스템 사용법을 안내하는 문서.
  • 백서 (White Paper): 문제와 해결책을 깊이 분석한 보고서.
  • 용어집 (Glossary): 문서 내 전문 용어와 그 뜻을 정리한 목록.
  • 인덱스: 키워드와 페이지 번호를 연결해 검색을 돕는 목록.
  • 현지화 (Localization): 특정 지역의 언어와 문화에 맞게 문서를 조정하는 과정.
  • WCAG (Web Content Accessibility Guidelines): 웹 접근성을 위한 국제 가이드라인.

B. 참고 자료 및 추천 도서

기술적 글쓰기를 배우고 심화하는 데 도움이 되는 자료와 책을 추천합니다(2025년 기준 최신판 반영).

  • 도서:
    1. “Technical Writing: Process and Product” (Sharon J. Gerson & Steven M. Gerson, 9판, 2023)
      • 기술적 글쓰기의 기본 과정과 실습 중심 가이드.
    2. “The Elements of Technical Writing” (Gary Blake & Robert W. Bly, 4판, 2022)
      • 간결하고 명확한 글쓰기 원칙에 초점.
    3. “Writing for Science and Engineering” (Heather Silyn-Roberts, 3판, 2024)
      • 과학, 공학 분야 문서 작성에 특화.
    4. “Docs for Developers: An Engineer’s Field Guide” (Jared Bhatti 외, 2021)
      • 소프트웨어 문서와 API 가이드 작성법.
  • 온라인 자료:
    • Write the Docs (writethedocs.org): 기술 작가 커뮤니티와 리소스.
    • X의 기술 글쓰기 토론: 2025년 트렌드 탐색(검색어: #TechnicalWriting).
    • Coursera – “Technical Communication”: 실습과 강의 제공.

C. 템플릿과 체크리스트

작업을 시작하거나 점검할 때 바로 사용할 수 있는 템플릿과 체크리스트입니다.

C-1. 템플릿: 간단한 사용 설명서

[제목: 제품명 사용 설명서]
1. 소개
   - 이 문서는 [제품/시스템]의 사용 방법을 안내합니다.
2. 준비 사항
   - 필요한 도구: [목록]
   - 사전 확인: [예: 전원 연결]
3. 사용 방법
   1. [단계 1: 동작 + 세부사항]
   2. [단계 2: 동작 + 시각 자료 참조, 예: 그림 1]
   - 경고: [위험 주의사항]
4. 문제 해결
   - [문제]: [해결책]
5. 결론
   - [작동 확인 방법 또는 추가 안내]
[그림 1: 캡션과 함께 이미지 삽입]

사용 예: "이어폰 사용 설명서"로 채워보세요.

C-2. 템플릿: API 문서

[엔드포인트: 요청 유형 /경로]
- 설명: [기능 설명]
- 파라미터:
  - [이름]: [타입, 필수 여부, 설명]
- 요청 예시:
  [코드 블록: curl -X GET "URL"]
- 응답:
  [코드 블록: {"key": "value"}]
- 에러:
  - [코드]: [설명]

사용 예: “POST /login” API로 작성해보세요.

C-3. 체크리스트: 문서 완성도 점검

  • [ ] 목적: 정보 제공, 지시, 설득 중 명확한가?
  • [ ] 독자: 초보자/전문가 수준에 맞췄는가?
  • [ ] 구조: 소개, 본문, 결론이 논리적인가?
  • [ ] 명확성: 모호한 문장 없이 이해 쉬운가?
  • [ ] 시각 자료: 다이어그램/표가 적절히 삽입됐는가?
  • [ ] 오류: 철자, 문법, 사실 확인 완료했는가?
  • [ ] 접근성: 색상 대비, 대체 텍스트 포함했는가?
  • [ ] 피드백: 최소 1인 이상에게 검토받았는가?

사용법: 최종본을 이 체크리스트로 점검하고, "X"가 없도록 수정하세요.

부록 활용법

이 부록은 여러분의 기술적 글쓰기 여정을 지원하는 도구 상자입니다. 용어집으로 개념을 다지고, 추천 도서를 읽으며 깊이를 더하고, 템플릿으로 빠르게 시작하며, 체크리스트로 완성도를 높여보세요. 2025년의 기술적 글쓰기는 여러분의 손에서 어떻게 진화할까요? 지금 시작해보세요!