by
Oct 07. 2023
개발자 글쓰기 #2-아웃라인
생존형 개발자의 생각 #87
“글쓰기의 최종결과는 독자의 사고방식이다”
”코딩의 최종결과는 프로그램의 사고방식이다”
글쓰기와 코딩은 “사고방식”이라는 “지능(논리)”을 “인공”으로 주입시키는 과정이라는 점에서도 일맥상통하지만, 둘 다 똑같이 버그를 양산해낸다. 개발자 또는 필자가 주입시킨(Injection) 맥락(Context)과 단어(Data)에 다양한 오류가 있기에 "예상치 못한 결과(반응)"를 만들어내기 때문이다. 그래서 프로그램은 "오동작", 글쓰기는 “오해 또는 오독”을 발생시키는 경우가 빈번한다.
bing: 프롬프트 "기계적 사고방식으로 프로그래밍하는 개발자를 수채화로 그리기"일러두기: 다음 글은 3꼭지 정도로 완성될 것이다. 지금은 2꼭지이다. 개발자 대상으로 “평이한 글(?)”을 작성하는 방법을 정리한 것이다. 이유는 몇 몇 공학계열의 지인들이 일반인을 위한 책을 써야 한다. 그래서 조언하다보니 만나서 알려주는 것보다 summary한 내용을 공유하는 것이 훨씬 효율적이라는 판단되어 정리했다.
아이디어 차원으로 쉽게 쓰는 글은 “메모와 notion”만으로 작성가능하다. 그러나 중요한 전략, 기술 문서 또는 책과 같은 "분량이 요구되는 글"을 써야 한다면 “마인드 맵” 또는 아웃라인을 지원하는 에디터를 사용하여 “뼈대문서”를 만들게 된다. 이유는 정확한 내용(검증된 데이터)으로 깔끔한 맥락(Context)을 만들기에는 아웃라인으로 글쓰기가 도움이 되기 때문이다. 마인드 맵도 좋긴하지만 나중에 문서로 publishing 하기에는 불편함이 있다. 그래서 아웃라인 문서를 애용하는 편이다.
아웃라인 문서는 특별한 것이 없다. 소위 말하는 “지식이나 학(學)”이 들어간 문서라면 “목차”가 핵심이된다.목차에 글쓰기를 집중했다고 보면 아웃라인 글쓰기를 이해하기 쉽다. 결국 아웃라인 글쓰기는 “목차 is 글”이 되는 작성법이다. 핵심에 집중하고 불필요함을 제거하는 글쓰기가 “아웃라인 글쓰기”인 것이다.
개발자들이 글을 쓰려고 할 때마다 아웃라인 글쓰기(개발툴)와 프로그래밍적 사고방식(데이터와 맥락만들기)을 강권한다. 개발자가 쓰는 글은 어떤 장르의 글이던간에 “구조적”일 수 밖에 없다. 그리고 “구조적 글쓰기” 기반으로 다른 분야의 글을 쓰다보면 어느정도 해당 분야에서 구조적 글쓰기를 활용하는 법을 “강화학습(Reinforcement Learning)”으로 터득하게 된다. 강화학습? 너무 어렵게 생각할 필요가 없다. 1만시간의 법칙과 같은 “머리가 아닌 몸으로 맞으면서 배우는 기간”이 필요하다는 것이다 .
아웃라인 문서
아웃라인 문서의 외형적 특징은 -> 들여쓰기이다.체계화된 문서를 만들기위해 들여쓰기를 활용하여 문서의 계층을 만드는 방법이다. 목차와 글쓰기의 혼합형이라고 보면 된다. 완성된 문서를 쓰기에는 무리가 있지만 “글쓰기를 전략적, 구조적”으로 구상한다면 아웃라인 글씨기만 만들어놓아도 큰 문제가 없다. 아웃라인 구조에 “채워넣기(글쓰기)”만 하더라도 완성도 높은 문서가 나오기 때문이다.
OPML(Outline Processing Markup Language)이란
4~5 년전에 표준화가 시작되었다. 개발자가 아니더라도 다양한 분야의 엔지니어, 학자, 기획자들에게 관심사항은 구조적 글쓰기이다. 그러다보니 아웃라인 글쓰기는 다양한 프로그램으로 제공되기 시작했고 그 프로그램간의 데이터 호환을 위해 규약이 나왔다. 그것이 OPML(Outline Processing Markup Language)라는 XML 규격이다. 그러므로 이 파일만 백업하고 있으면 다양한 구조적 글쓰기 프로그램을 갈아타며 활용할 수 있다. 그리고 약하게나마 Notion도 OPML을 지원하고 있다.
아웃라인 문서의 활용법
외형이 개발자들에게 친숙하다. 대부분의 IDE(통합개발환경)가 "들여쓰기에 가이드 라인"을 제공하기 때문이다. 개발자들은 개발자가 아닌 사람들을 위한 글을 써야할 경우, 스트레스를 받는다. 문서의 구조가 많이 다르기 때문이다. 그러나 디테일하게 따져보면 구조적 글쓰기는 개발자에게 더 친숙하고 쉬운 방법이기도 하다.
프로그램을 만들시, (1) 구조설계 → (2)모듈화 → (3)코딩의 단계를 거치 듯 글 쓰기도 같은 방법으로 (1) 맥락만들기 → (2) 항목 나누기 → (3) 항목을 주제로 글쓰기와 같이 만들기 때문이다. 글쓰기나 프로그래밍이나 (3)의 경우는 Template화 된 영역이다. 어디선가 자주 사용되는 효율적인 문구(프로그래밍에서는 code snippet)를 적용하는 것이 주된 할 일이 된다. 그러므로 가장 중요한 것은 (1), (2)가 된다. 글쓰기 또는 프로그래밍 모두 같다.
개인적으로 추천하는 아웃라인 툴은 다음과 같다. 대부분의 아웃라인 툴이 MD(MarkDown) 문법을 제공한다. 이 서비스도 MarkDown 기반이다.
Outline 문서작성을 시작하자 - Dynalist
Next
Prev
