메뉴얼을 작성하는 문서화 팀에서  어느정도 규격화된 지침서가 필요하지 않을까 하는 생각입니다.

그래서 아래와 같이 작성해봤는데 의견을 모아서 틀을 좀 잡고 진행했으면 합니다만... 의견을 어떠신지...


 http://cglink.springnote.com/pages/676397
=====================================================================================================================
제(cglink)가 임의로 적어본 지침입니다.

문서화 커뮤니케이션 채널이 생긴다면 지침서의 내용을 결정하는데 의견조율 후 의결된 내용만 첨부하고 작성자는 지침서를 최대한 준수하도록 해야겠습니다.

 

 

작성 절차 관련 지침^#

 

내용 관련 지침^#

zb4는 배제^#

zb4와 zbXE의 차이점에 관해서는 What's New 에서 일괄적으로 다루고 사용자, 스킨, 개발자 메뉴얼은 오로지 zbXE에 포커싱 해서 작성하도록 합니다.

기존 zb4 사용자들을 위한 비교설명이 뒤섞이면 zbXE 메뉴얼이 아니게 됩니다.

What's New를 제외한 나머지 페이지에서는 타겟을 분명히했으면 합니다.

 

용어 표기 통일^#

zeroboardXE 의 약칭 = zbXE (대소문자 구분) 으로 통일.

zeroboard4 의 약칭 = zb4

스킨문법 => 템플릿스크립트 문법 = TS(TemplateScript) 문법

와 같은 식의 용어를 통일 시키고자 합니다.

 

zbXE 내에서 만들어진 자체적인 용어 외 보편적인 대명사, 전문용어, 용어의 약칭은 가장 전문적이고, 정확한 근거를 가지는 명칭을 선택하여 혼동이 없도록 합니다.

 

문체는 어떻게?^#

문어체 보다는 구어체가 더 좋지 않을까요?

딱딱한 문어체가 더 공식적으로 보이기도 하긴 한데... 음...

읽는 사람의 이해도는 구어체로 적는 것이 더 좋고...음... 심리적으로 머리에 더 잘 들어온다고 합니다.

 

그림의 크기^#

문서 내부에 첨부되는 그림은 가로 640 픽셀 정도를 기준으로 최대 800 픽셀 이내로 작성합니다. (이런 기준은 필요할듯..)

너무 크면 보기 불편하니까요.

그리고, 그림안의 TEXT를 읽어야하는 그림, 예를들어 화면을 캡춰했을때 그중 특정한 부분을 보여줘야할 때는 가독성을 고려해 Resize 되지 않도록 편집합니다.

 

소스코드 작성^#

소스코드는 반드시 스프링노트의 "소스코드 인용단락"을 이용하고 소스코드 안에서 주목해야할 부분은 눈에 잘 들어오도록 컬러링을 해줍니다.

너무 긴 소스크드의 경우 설명과 직접적인 관련이 없는 부분은 ~생략~ 또는 ...생략... 을 활용합니다.

 

 

 

 

 

문서 구조 관련 지침 (표준형식).^#

단락제목^#

단락제목은 가장 위에 "단락제목1 (h1)"을 쓰고 그다음 +2 씩 올라가도록 합니다.

즉, 1, 3, 5 만 사용하도록 합니다.

이렇게 하는 이유는 +1씩하면 스프링노트의 스타일시트 상으로는 크게 구분이 되지 않기 때문입니다.

 

인용 및 코드인용 단락 구조 사용^#

스프링노트의 기능 및 문서구조를 가능한 지켜서 사용합니다.

스프링노트만의 독특한 구조는 아닙니다.

XHTML 표준에 맞춘 보편적인 문서의 구조를 따라서 작성하는 것이라 보면 됩니다.

 

확장기능을 통한 목차만들기^#

페이지의 내용이 길어 스크롤이 생기면서 내부분류가 있을 때는 만드시 목차를 생성해 줍니다.