<문서작성>

1. 참고하는 책의 그림은 그대로 그리지 말고, 가능하면 조금 변경해서 그린다.

2. 그림은 많이 추가할수록 좋은 문서이다. 그림은 문장을 쉽게 이해되도록 도와준다. 그림을 짜임새 있게 잘 그리는 것도 필드에서 많이 도움이 된다고 한다(예를 들어 부서에서 프레젠테이션을 할 경우).

3. 그림을 문서에 추가할 경우 되도록 그림에 대한 언급이 먼저 나오고, 그림이 그 다음에 나오고, 마지막으로 그림에 대한 설명이 나오도록 한다. 그림 안에는 각 구성 요소와 항목을 나타내는 글이 추가 되어야 한다.

예)

그림 5-4에는 ..... 에 대한 블록 다이어그램이다.

...................................................................

...................................................................

....................................................................

....................................................................

그림 5-4

(그림 설명 시작)

위의 그림에서..........

그리고 그림은 편집 용지에서 중간에 위치하는 것이 바람직하며, 용지 공간을 절약하기 위해 그림을 한쪽으로 배치하고 글을 그 옆에 위치시키면 책을 읽는 사람의 눈만 피곤해질 뿐이다. 항상 위와 같은 형식으로 글과 그림을 배치한다.

4. 6하 원칙을 철저하게 지킨다. 특히 문장에서 주어를 생략하지 않도록 한다.

앞 문장에서 이미 주어를 언급했기 때문에 뒤에서 생략하는 실수를 많이 하게 될 것이다. 주어가 길어도 생략하지 않고 계속 언급해 주는 것이 좋다.

<예문>

주어가 생략되었을 경우:

.abx 파일은 Absolute Binary Data Format의 Raw 데이터 이미지로서 .bin 파일처럼 다운로드 과정에서 필요한 Checksum과 같은 데이터는 포함되지 않는다. .bib 파일의 설정으로 생성되며 JTAG을 사용해서 롬 장치에 이미지를 프로그래밍 할 수 있다.

-->여기서 .bib 파일의 설정을 생성되는 것은 .abx 파일이다. 하지만 주어가 생략되어서 독자는 앞 문장을 다시 읽어야 이해를 하게 된다.

수정:

.abx 파일은 Absolute Binary Data Format의 Raw 데이터 이미지로서 .bin 파일처럼 다운로드 과정에서 필요한 Checksum과 같은 데이터는 포함되지 않는다. ..abx 파일은 bib 파일의 설정으로 생성되며 JTAG을 사용해서 롬 장치에 이미지를 프로그래밍 할 수 있다.

6. 영어 표현은 되도록 한글 표기로 변경한다(예 : 데이터(Data)). 이때 한글 발음 표기는 문서전체에서 통일시켜야 한다. 이를 위해 단어 하나라도 한글로 변경하면 MSN 메신저를 통해서 문서 작업을 하고 있는 다른 동료에게 알린다. 전달된 한글 표기 단어들은 하나에 파일에 바로 기록해서 모아둔다. 한글로 표기해야하는 단어는 문서작업을 하면서 수시로 확인해야 한다. 문서를 작업하는 팀 내에서 기준을 정하는 것이다.

7. 약어 표현은 “약어(풀이)” 한 형식으로 언급한다.

예: MSDN(Microsoft Development Network), PDA(Personal Digital Assistant)

8. 약어와 한글 표기가 문서 전체에서 처음 사용될 경우 반드시 약어에는 약어 풀이는 한글 표현에는 영어단어를 덧붙여야 한다. 즉 약어 풀이를 하는 ( ) 는 문서전체에서 약어가 처음 사용되는 곳에 위치해야 한다. 문서에서 두 번째로 사용되는 약어부터는 약어 풀이를 붙이지 않아도 된다. 한글 표기 역시 문서에서 맨 처음 사용될 때 “한글(영어)” 라고 표시해야 하며 두 번째 사용부터는 “(영어)” 를 붙이지 않아도 된다.

9. 번역을 하다보면 문장이 영어식 표현이 되는 것에 주의한다. 영어는 관계사로 길게 이어질 수 있다. 이런 경우, 문장을 2~3개로 분리하는 것이 깨끗한 표현이 된다. 물론 이때 분리된 문장에서 주어는 반복되게 된다(위의 4번 사항). 문장의 길이가 평균적으로 8단어일 때 가장 한국 사람이 이해하기 쉬운 문장이라고 한다 (테크니컬 라이팅 강의에서).

영어식 표현에서 명사의 복수 표현은 자제한다.

10. 주로 모든 문장은 능동문을 사용한다. 능동문은 피동문 보다 논리를 강하게 한다. (예: 누나가 동생을 업다. -> 능동문,  동생이 누나에게 업히다.-> 피동문)

11.  구어체는 테크니컬 문서에서 사용될 수 없다. ( 구어체의 예: ~ 해보자. ~ 하자.)

12. 문서가 책으로 출판되는 경우에는 다른 책을 이해해서 요약하는 것은 괜찮다.

13. 책을 출판하는 경우 인덱스 즉, 찾아보기를 만드는 것은 기본이다. 이때 키워드는 문서를 작성하면서 수시로 기록한다. 나중에 한꺼번에 하려고 하면 시간도 많이 걸리고 제대로 키워드가 모이지 않는다.