개발자 문서작업 가이드라인

개발자 문서작업 가이드라인

 

 

- 버전

1.0 완성버전

0.1 업데이트 - 콘텐츠 추가
0.11 패치 - 오류 수정
0.111 핫픽스 - 당장 고쳐야하는 급한 버그 등 

1.1a 알파버전 - (Focus Group Test) 
비밀유지 각서 NDA, MOU체결한 곳에 테스트를 부탁하기도 함
1.1b 베타버전 - 외부 테스트 (OBT - 오픈 베타 테스트)
내부 테스트 (CBT - 클로즈드 베타 테스트) 
Early Acsess
1.1


기획서 작성법

1)기획서

 기획서는 실제로 개발자가 개발을 하기 위한 작업문서이다.
 
 실제로 프로그래머나 아티스트가 기획서를 보고 무엇을 어떻게 
만들어야 할 지 알고나서 개발에 착수할 수 있도록 해야 한다.

 기획서에는 여러 종류가 있다. 제안서, 콘텐츠 기획서, 시스템 기획서
등이 있는데, 각각 그 기획서를 볼 사람들이 다르다.

 콘텐츠 기획서라면 아티스트가 주로 보게 되고, 시스템 기획서는 
프로그래머가 주로 보게 된다.

 기획서는 읽는 대상에 맞춰 이해하기 쉽도록 쓸 필요가 있다.


2)제안서

 제안서는 팀장 및 팀원들에게 콘셉트 및 재미 요소를 보여주기 위해 쓴다.

 기획 의도, 개발 목표, 콘셉트, 재미 요소가 꼭 들어가야 한다.

 
3)콘텐츠 기획서

 콘텐츠의 컨셉이 명확해야 한다. 그렇지 않으면 의도와 다른 결과물이
나올 수 있다.

 아티스트가 작업하는 영역에 대해 알 필요가 있다. 
아티스트의 경우 기획자보다 뛰어난 능력을 가진 부분이 있기 때문에
그들의 작업에 제한을 걸어둘 필요는 없다.

 기획서는 읽는 당사자가 어떤 리소스, 몇 개의 결과물을 만들어야 
하는지 파악하기 쉽게 해야 한다.


4)시스템 기획서

 명확한 규칙이나 진행 방식 등을 설명해 줘야 한다.

 실제 게임에서 구현하기 위해 꼭 필요한 내용의 설명이 반드시 
들어 있어야 한다.

 프로그램 및 개발 툴에 대한 기본적인 이해가 있어야 프로그래머와
의사소통 하기 쉬운 문서를 만들 수 있다.

 문서를 보고 실제 작업에 착수 할 수 있도록 자세하게 무엇을 
만들어야 한다는 것을 알려줘야 한다.


5)효율적인 문서

 긴 문장으로 설명하는 것은 좋지 않다. 짧고 간결한 문장으로 핵심을 전달

 전문용어를 정확히 알고 쓰기 위해 수 많은 경험이 필요

 워드의 이해, 팀에서 작성하는 전문용어의 이해, 개발에 사용되는 툴에
대한 이해가 필요하다.

 효율적인 인포그래픽이나 이미지를 스케치하여 설명하면 훨씬 효과적


6)기획자의 일

 기획서를 작성했다고 끝나는 것이 아니다.

 기획서 작성 후에 프로그래머와 아티스트의 계속해서 회의하면서 
수정해 나가는 과정은 반드시 따라온다.

 프로토타입을 통해 기획서의 내용을 검증해보는 것이 제일 좋은 방법


7)글쓰기

 글을 쓴다는 것은 논리적인 사고를 훈련하는 것이다.

 자신의 할 말을 짜임새 있게 구성할 수 있는 능력도 함께 증진된다.

 글 쓰는 훈련을 평소에 해야한다. 에세이나 일기 등을 쓰면서 꾸준히
자신의 생각을 쓰고 남에게 읽어보게 하고 첨삭을 받는 것이 좋다.


쓰기 지침(설명을 위한 목적 등)

1)간결하게 쓴다

 초점을 맞추었다 ->초점을 맞췄다
 정리하여 -> 정리해서, 정리해
 ~하였다 -> 했다

3)가급적 쉬운 표현을 쓴다


4)명사형 표현을 과도하게 쓰지 않는다


5)불필요한 조사를 뺀다


6)쉼표 사용을 가급적 자제한다


7)영어 표현을 가급적 한글 표현으로


8)자주 쓰는 표현은 가급적 한글로



문서양식 원칙

1)원칙


 최종 수신자는 누구인가? 어떤 사람인가?

 그는 무엇을 알고 있는가?, 무엇을 알고 싶은가?, 어떤 기대치를 갖고 있나?

 문서로 작성할 가치가 있는 일인가?


2)양식 만들기

 문서 양식은 작성자의 스타일 드러난다.

 다른 사람이 작성한 양식은 그 사람이 고민 끝에 만들어진 자신만의 대화법

 양식을 개선해 나만의 대화법을 만들자.


내용구조

 

pt 가독성

 

1)활용

 

 줄 및 단락 간격 조정하기

 

 목록 수준 조정하기 - 같은 수준의 내용을 같은 모양으로 들여 쓰거나 내어 쓰면

상하위 개념의 구분이 쉬워 내용 파악이 간단해진다.

 

 화려한 폰트는 제목에만 사용한다.

 

 대중적이고 가독성 높은 폰트를 사용한다.

 

 폰트 숫자는 최대 3개로 제한한다.

 

 

문장론

 

 멋지고 화려하게 쓰지 말고 초등학생도 이해할 수 있도록 작성한다.

 

 짧은 문장을 사용한다.

 

특이한 점은 이 Issue가 1년만 더 지속된다면 이 Issue는 자동적으로 소멸될 것이다.

-->

이 문제가 1년 더 계속된다면 스스로 사라질 것이라는 점은 특이하다.

 

현재처럼 외부의 반도체 가격이 아주 불안정한 상황에서는, 직접 다른 partner를 찾으려면, 신규 업체의 발굴에 대한 시간이 상당히 많이 걸리고, 여러가지 어려움도 많고, risk의 발생 및 추가 손실의 가능성도 있기 때문에, 가능한 한 기존 업체와의 제휴 협상에 최선을 다해야 한다고 판단됩니다.

-->

 

현재처럼 반도체 가격이 불안정한 상황에서는 신규 파트너를 찾는 것은 시간 소모와 리스크가 많아 기존 업체와의 협상에 주력해야 함.