개발 문서에 대한 이야기

가끔 개발 문서를 보면 외계어를 만들어놓거나, 

 

---------------------------------------------------------------------------------

나는 가끔 special한 액티비티의 limitation을 억제하기 위하여

---------------------------------------------------------------------------------

 

무한 서술형이거나,

 

---------------------------------------------------------------------------------

이 편지는 영국에서 시작하여..

또... 영국에서 시작하여..

... 중략

... 영국..

영..

국.

---------------------------------------------------------------------------------

 

 

무한 단락 연쇄술을 펼치는 경우가 있다.

 

---------------------------------------------------------------------------------

1. 무한

  1) 무한의 무한

      ㄱ. 무한의 무한의 무한

          i. 무한 연쇄술 !!

---------------------------------------------------------------------------------

 

힘들다. 읽기가 

 

나는 잘 써진 개발문서는 다음과 같은 조건을 가진다고 본다. 

 

1) 처음 본 사람이 봐도 이해하기 쉬워야 한다.

2) 충분한 그림과 캡쳐를 사용한다.

3) 자신이 오랫만에 읽었을 때 뭔 소린가 이해가 갈 정도로 논리정연한 편이 좋다.

4) 다른 사람에게 검토를 좀 받자. 

 

위의 내용을 종합해보면, 

 

충분한 그림과 캡쳐, 사례를 중간 중간에 삽입해서 이해하기 쉽게 만들면서

읽기 쉬운 가독성과 논리를 지니는지 타인에게 검토를 받아보고, 

처음 본 사람이 봐도 이해하기 쉽게 만들게 연습하다보면,

개발 문서는 잘 쓸 수 있게 된다. 

 

4번이 가장 중요하다.

남들에게 피드백 받았을 때 뭔가 이해하기 어려우면, 

결국 내 만족에 의해서 만드는 문서일 뿐이다. 

문서는 보여주기 위한 목적을 가진다. 

 

문서를 잘만들면 일단 내가 안피곤해진다. 

반복 설명하고 똑같은 것 또 설명안해도 되고,

유지보수하거나 인수인계할 때 편하다. 

그리고 사실 문서는 기본이다. 

또한 개발할 때의 예의이다.