2006년 5월 26일 금요일

(나만의) Technical Writing 원칙

요즘 재미없는 포스트만 올리네요. 다른 얘기를 좀 해볼까요?

근자에는 새벽마다 C++ 원고 교정을 하고 있습니다. Technical Writing에 대한 철학까지는 아니더라도 원칙정도는 필자에게 있습니다. 그것은 다음과 같습니다.

[1] 글은 내 지식을 자랑하기 위함이 아닌 독자들이 원하는 지식에 쉽게 접근하도록 하기 위함이다.

-> 독자들이 돈을 지불하는 이유는 필자를 좋아해서도, 돈이 남아서도 아닙니다. 책에 들어 있는 정보를 위함입니다. 정보를 쉽게 얻어갈 수 있도록 하는 것은 저자의 책임입니다.

[2] 모든 것을 설명하기 위해 하나도 설명하지 못하는 실수는 하지 않는다.

-> "통계를 알면 인생이 달라진다(오오무라 히도시/자음과모음)"라는 책을 읽으면서 얻은 깨달음입니다. 이 책은 300페이지 정도의 얇은 분량으로 베게만큼 두꺼운 통계책보다 더 많은 것을 필자에게 가르쳐줬습니다. 과하면 차라리 없는 것만 못한것이죠.
책을 쓰다보면 자신이 가진 모든 지식을 글에 부어넣고 싶은 욕구가 드는데, 그 때 한걸음 뒤로 물러나서 이 내용이 꼭 필요한 것인가 하는 고민을 합니다. 물론 꼭 필요한 것이 빠지진 않았는가 하는 생각도 함께 말이죠. 그래서 "~~ 바이블"이 되지 않을 수 있었습니다.

[3] 책은 돈을 위해서가 아닌 공헌을 위해서 쓰는 것이다.

-> 책... 들인 시간에 비한다면 금전적으로는 얻어지는 것이 거의 없습니다. 물론, 필자의 글재주가 형편없기때문이기도 하지만, 그 시간에 소위 "알바"라도 뛰었다면 필자, 아마 좋은 차 한 대 샀을겁니다. 필자가 갖고 있는 것을 후배에게 나눠준다는 마음으로 글을 쓴 것이고, 그나마 받는 인세 또한 국제 청소년 연합(Iternational Youth Fellowship)을 위해 사용합니다.

새로 나올 책도 위 원칙에 의해 검토를 쭉 하고 있습니다. (가장 고민되는 것이 문체가 지금 반말로 되어 있다는 것입니다. -.-;; 예를 들어 "int형은 다음과 같은 데이터를 표현할 수 있다."처럼 말이죠. 아무리 봐도 이건 아닌 것 같다는 생각이 드는데.. 의견 있으시면 코멘트 부탁 드리겠습니다~~ )
출판까지는 약 2~3달 정도가 소요되겠네요.  ^^


네... 뭐 오늘도 상당히 쓸데없는 글이었습니다. ㅋㅋㅋㅋ
이맘 때쯤이면 진도가 빠른 독자들은 "클릭하세요 C# 2.0 프로그래밍"을 한번 다 봤을 것 같네요. 깊이 있는 주제로 글을 하나씩 쓰려고 합니다. 물론 연재 주기는 규칙적이진 않을 겁니다. ^^;

댓글 2개:

  1. 건의사항이 있습니다.

    먼저 집필하신 [비주얼 C#... 프로그래밍]이 좋은 책인 것은 분명한데, 한가지 아쉬움이 있다면 "왜?"라는 질문이 좀 부족한 것이 아닌가 싶습니다.

    예로 저번에 질문드린 delegate를 들 수 있습니다.

    문법적인 설명은 아주 잘되어 있는데 왜 그것을 써야 하는지, 등장배경이 무엇인지에 대해 좀 더 자세한 설명이 있으면 좋겠다는 생각입니다. [물론 행간을 읽고 그 의미를 파악하는 것이 더 훌륭한 공부라는 철학으로 책을 썼을 수 있고, 충분히 설명이 되어 있는데도 현송이가 아둔해서 그럴수도 있네요]. VS2005 책도 곧 나오는 거지요?

    답글삭제
  2. 의견 감사합니다. C# 첫 컬럼은 "delegate에 대한 고찰"부터 시작하는 것으로 고려하겠습니다. ^^;

    답글삭제