이 문서는 매뉴얼 작성자가 일아야 할 {doctitle} 에 대한 기본적인 사항을 설명합니다.
--
== 문단 구성
매뉴얼의 실제적인 뼈대를 구성하는 단계이다. 사용자의 동작과 제품의 취급방법이 시계열의 흐름 속에서 설명되어야 하고, 제품의 각 기능에 대한 설명 은 공간적 구성으로 이루어지며, 조작방법은 논리적인 순서를 따라 사례를 중심으로 구체적으로 설명해야 한다.
* 상향식 목차 구성
** 생각나는 주제에 해당하는 소제목을 가급적 많이 작성한다.
** 관련 있는 소제목끼리 유형별로 분류하여 중간제목을 만든다.
** 중간제목을 모아 대제목을 만든다.
** 각 소제목의 문장을 써 나간다.
** 다시 읽어보고 필요하다면 제목 단위로 이동한다.
** 내용의 경중, 문장의 양에 따라 제목의 순위를 정한다. 전체 체계를 다시 정리한다.
* 하향식 목차 구성
** 큰 주제에 대해 논리적으로 수평축을 정한다.
** 수평축에 해당하는 각 항목마다 이를 뒷받침하는 하향식 소제목으로 구성한다.
** 각 소제목은 원인과 결과를 설명하는 과정이 된다.
** 각 수평축은 앞부분과 뒷부분이 상호 논리적인 흐름을 갖게 되므로 논리적 비약을 예방할 수 있다.
== 본문 작성
다음은 문단 구성을 완료하고 본문을 작성할 때 고려해야 할 사항이다.
=== Plain Writing
* 긴문장 → 단문
* 수동태 → 능동태
+
----
~된다 → ~한다
----
* 능동적이고 긍정적인 표현으로 작성한다.
+
----
~안 된다 → ~된다
----
* 명확한 의미의 동작을 사용한다.
+
----
표4는 성공률과 에러율에 대한 목록이다. → 표4는 성공률과 에러율에 대해 설명하고 있다.
----
* 필요없는 말 생략(의미없는 표현 제거)
* 전문 용어 남발 주의
* 불필요한 설명 지양
=== 띄어쓰기
* 조사는 붙여 쓴다.
+
----
시스템은
----
+
* 의존 명사는 띄어 쓴다.
+
----
사용 중, 제품 표면에 돌출된 것
----
* 단위를 나타내는 명사는 띄어 쓴다.
+
----
세 번째 시도하여
----
* 접사는 붙여 쓴다.
+
----
제1장, 오름차순
----
* 열거할 때 사용하는 단어는 띄어 쓴다. “또는”이나 “및”과 같이 열거할 때 사용하는 단어는 띄운다.
+
----
사물 또는 사람
----
* 보통명사나 부사로 굳어진 경우 붙여 쓴다.
+
----
그때 전원이 들어온다면
----
* 보조 용언은 띄어쓴다.
+
----
이 경우에는 혼자 힘으로 알아 내어야만 한다.
----
* 복합 동사는 붙여 쓴다. 접미사 “~없다”는 붙여 쓰지만 형용사 “~없다”는 띄어 쓴다.
+
----
끊임없이 반복을 하는 경우
----
* 전문 용어의 경우 붙여쓰기를 허용한다.
+
----
응용프로그램
----
* 복합어(명+명)
복합어는 붙여 써도 되고 띄어 써도 된다. 해당 복합어가 일반적인 용어로 사용되는 경우는 붙여서 사용 한다. 단,영어+한글이 혼합되어 복합어가 되는 경우는 띄어 쓴다. 띄어쓰기로 결정된 단어는 모든 메시 지에 동일하게 띄어쓰기를 하고 붙여쓰기로 결정된 단어는 붙여서 사용한다.
