(나만의) Technical Writing 원칙

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

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

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

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

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

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

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

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

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

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

거울과 창

예전에 Good To Great이라는 책을 읽은 적이 있습니다. 우리나라에는 "좋은 기업에서 위대한 기업으로(맞나?)"라는 제목으로 출판된 걸로 알고 있습니다.

모 증권사 CEO로 계시던 분의 이야기를 듣다가 이 책에 대해 듣게 되어서, 저도 구입해 읽게 되었습니다. 이 책의 내용은 제목처럼 그저 괜찮고 좋은 기업의 수준을 넘어 위대한 기업으로 가는 기업들의 특징은 무엇인가에 대해 다루고 있습니다.

그 중 Mirror and Window(거울과 창)에 대한 내용이 많이 마음에 남았습니다. 책에 의하면 위대한 리더(Level 5 Leadership(뭐라 번역해야 할지;;;)을 가진 리더)는 전문가적인 소양 뿐 아니라 겸손한 인격을 갖고 있다고 합니다.

위대한 리더는 잘못된 일에 대해서는 거울을 비춰보며 자신에게서 문제점과 책임을 찾고, 잘된 일에 대해서는 창을 통해 밖을 내다보면 누구에 의해 이 일이 잘되었는지를 찾습니다. 특히 잘못된 일에 대해서는 어떤 외부적인 요인이나 환경 탓도 절대 하지 않는다는 것이 특징이죠.

저도 거울과 창을 가지고 있지만 사용하는 때는 위대한 리더와는 많이 다른 것을 느낍니다. 잘되고 있을 때는 몰랐는데, 문제가 생길 때는 당장 변명거리부터 찾고 있는 나를 발견했습니다. (내가 바뀌겠다고 해서 순식간에 바뀌진 않겠지만, 일단 내 자신을 알면 거기서 문제의 실마리가 풀리기 시작하겠죠? 소크라테스가 말한 것처럼요.)

책이 단순히 지식 역할만 하는 줄 알았는데, 나를 비춰보는 거울 역할도 해주네요. ^^
아니, 지식이 거울 역할을 해주는 건가요? ㅋㅋㅋ

설계문서, 사양서 없이 개발한다는 것.

설계문서, 사양서 없이 개발한다는 것.

건축물이 구축되려면 치밀한 설계도와 그 설계도를 준수하기 위해 필요한 공법까지 사전에 준비가 되어야 합니다. 설계 기술이 좋아져서 요즘은 설계도가 나오면 3차원 영상으로 미리 건물 내/외부를 이리저리 돌아다니면서 실제 건축된 후의 모습을 미리 볼 수도 있습니다.
건축물 뿐 아니라, 싱크대를 하나 짜더라도 어떤 디자인, 어떤 치수, 어느 자재를 사용할지를 사전에 설계를 하지요. 자동차, 기계, 그 어떤 가공물도 - 적어도 "제품"이라면 - 설계 없이 만들어지는 경우는 거의 없습니다.

소프트웨어의 설계 문서란, 소프트웨어의 전체적인 구조에서부터 특정 루틴에 이르는 소프트웨어 구현에 필요한 상세한 청사진을 말합니다(물론, 설계 문서의 종류는 다양합니다만.). 사양서는 설계 문서와는 다르게 소프트웨어가 어떤 역할을 하며 어떤 방식으로 동작한다라는 소프트웨어의 사양을 기술하는 비교적 간단한 문서입니다.

어떤 관리자들은 "바쁘기 때문에", 혹은 "시간이 없기 때문에" 이 문서들을 준비하지 않고 개발자들에게 개발을 시작하라고 합니다. 1~2억이 투자되는 소프트웨어 개발을 말이죠.

이렇게 되면 개발자들은 그야말로 "알아서" 개발을 시작합니다. 열심히 한 개발자는 나중에 열심히 새로 개발해야 하는 상황이 발생하고 얍삽한 개발자들은 어느정도의 결과물이 나오면 일단 소스 코드를 릴리즈를 하고 반응이 오면 고칠 준비를 하고 기다립니다. 자신이 작성한 소프트웨어가 "과연 그렇게 동작해야 하는가"하는 의문이 서기 때문이죠. ( 어느 쪽이든 욕을 먹지만, 후자쪽의 개발자가 욕은 더 많이 먹습니다. ) 결국 결과물은 어떻게 어떻게 해서 나오게 되지만 "이게 우리가 2억을 들여 만든게 맞습니까?" 하는 이야기를 듣게 됩니다.

설계서, 사양서는 개발 하면서도 계속해서 수정되고 릴리즈되어야 합니다. 마치 건축물 설계도가 그러하듯이 말입니다. 그리고 개발자들은 필요하다면 수정된 문서에 의해 자신의 소프트웨어를 변경해야 합니다.

뜬금없이 왠 설계, 사양서 얘기냐구요? 이런 생각을 하게 하는 일들이 있었거든요.
상황이 이랬거나 저랬거나 프로젝트는 완수해야죠. 오늘도 파이팅하면서 시작입니다! 즐프~

내 게임.

일을 하다 보면 문득 이 일이 잘 안되면 어떻게 하지, 잘 풀리면 어떻게 할까 하는 공상에 젖어들 때가 있습니다. 그러다 보면 집중이 안되고 그 일의 결과는 실패쪽으로 기울기 마련입니다.

마음을 비우고 "지더라도 내 경기를 하겠다."라는 자세를 가지는 요즘입니다.

S > Quark && S < Cosmos

사람이 관찰, 또는 추적할 수 있는 가장 작은 원소가 Quark,
또 가장 넓다고 추정하는 우주의 넓이...
하지만 Quark 보다 더 작은 세계가 분명 있을 것이고,
저 별 너머에는 우리가 보지 못하는 대 우주가 펼쳐져 있겠죠?

우리가 보는 시각은 쿼크에 한참 미치지도 못하고, 저 우주에도 미치지 못하는
극히 좁은 것에 지나지 않는데도 왜 우리는, 아니 나는 이렇게 교만한지 모르겠습니다.
아는 것보다 모르는 게 더 많은 나를 자꾸 잊어버려 큰일입니다.

아.. 일하기 싫다~~

이 그림을 그려놓은 건 몇년 전 신입 시절 때였습니다. 이런 그림을 그릴 힘이 있었던 것도
일하는 매 순간이 도전이었고 즐거웠기 때문이었다는 생각이 듭니다.

지금은 일이 미친듯이 많으면 '내 시간'을 뺏긴다는 느낌 때문에 조금 억울(?)하다는 생각이 들기도 합니다.
일로 하는 프로그래밍 때문에 "재미로 하는" 프로그래밍을 할 수 있는 시간이 줄어드는 것 같아 안타깝습니다. ^^;;

언젠쯤 재미로 하는 프로그래밍을 할 시간을 되찾을 수 있을까요?

- 일하기 싫은 놀토에 박상현.

비주얼 C# 2005 Express 다운 받기

많은 분들이 아직도  비주얼 C# 2005 Express를 어디서 구할 수 있는지 잘 모르시는 것 같습니다.

책의 뒤에도 나와 있지만 제가 다시 한번 여기에 적어놓겠습니다. ^^

비주얼 C# 2005 Express 아래의 주소에서 받으실 수 있습니다. 물론, 무료입니다!

http://www.microsoft.com/korea/msdn/vstudio/express/visualcsharp/