새로운 매뉴얼 작성 #17
Description
해당 이슈는 XE타운의 게시물 을 참고로 합니다.
제 개인적으로 현재 매뉴얼을 대대적으로 바꾸어야 한다 생각하는것은, 사이트 관리자가 거쳐야 하는 과정이 정확하게 담겨있지 않기 때문이라고 생각합니다.
- 사용자(사이트 관리자)/개발자 매뉴얼이 분리되어야 합니다.
- 사용자 중에서도 개설 목적에 따라 나누어야 하고, 개발자 중에서도 레이아웃/모듈 스킨 제작자인지, 애드온/모듈 개발자인지 분리해야한다고 생각합니다.
- 생각보다 현재 많은 XE관련 자료들이 파편화되어 있습니다. 한곳에 모아서 볼 수 있는곳이 라이믹스의 공식 문서였으면 좋겠습니다.
아래 내용들은 예시입니다. 이런 느낌으로 문서가 작성되었으면 합니다.
사용자 매뉴얼
- PHP, 서버, 심지어 웹호스팅이라는 개념을 모르는 유저들을 위한 설치 과정, 지원하는 서비스, 매뉴얼에서 특정 서비스에서의 설치 방법을 기술
- 특정 웹호스팅 기준으로 진행 과정을 비디오 혹은 스크린샷 형태로 기술
- 사이트 기본 설정, 레이아웃 설정, 모듈 스킨 설정, 메뉴 설정과 같은 공통된 기본적인 설정과정 기술
- 서드파티 자료 적용 방법
- 서드파티 자료 배포처(XE타운, XE공식 홈페이지)
- 서드파티 자료 적용하기
- 사이트 목적에 따른 세부 내용 적용
- 커뮤니티
- 포인트, 아이콘등 커뮤니티 특화 기능들 표시
- 포트폴리오
- 포트폴리오용 레이아웃 및 게시판 설정 방법
- Contact 폼 제작
- 개인 블로그 혹은 게시판
- 개인 블로그용 레이아웃 추천 및
- 사업자 홈페이지
- 사업자용 레이아웃 추천 및 게시판 설정
- Contact 폼 제작
- 기타
- 커뮤니티
- qna 문답형 페이지(자주하는 질문)
개발자 매뉴얼
- XE에서 Rhymix로 변화하면서 생긴 변화점들에 대한 서술
- 레이아웃/모듈 스킨/위젯 스킨 개발
- blade문법
- template문법
- 레이아웃 작성 방법
- 레이아웃 작성 가이드
- 모듈 스킨 작성 방법
- 게시판 스킨을 통한 모듈 스킨 작성 가이드
- 위젯 스킨 작성 방법
- 위젯 스킨 예제
- 애드온 개발
- 애드온의 기본 구조
- 애드온의 작동 원리
- 예제 애드온 작성
- 코어 심층 분석
- 모듈 개발
- 모듈의 기본 구조
API(폴더의 common/framework 쪽) 문서
- 자동화될 수 있으면 좋을 것 같습니다.
다음과 같은 느낌으로 아예 문서가 새로 기술되면 좋을 것 같습니다. 적고 나니 양이 상당히 방대한데, 아예 문서 기여 희망자들을 모아 팀을 만들고 문서를 완성해나가면 충분히 추진력을 얻어 작성할 수 있을거라고 생각합니다.