오픈 소스 프로젝트 - 문서화/ 매뉴얼 포럼
[토론주제] zbXE 공식매뉴얼 스타일가이드 관련(1) - 초기논의
토론주제의 제목을 구체적으로 정하지 못했습니다.
매뉴얼 스타일가이드(형식이나 디자인 등...) 관련해서는 지속적으로 논의 해야겠지만,
일단 이 토론에서는 우리가 참조 할 만한 예제 같은 것을 찾아서 장단점을 논해보는 것이 어떨까 해서 화두를 던져 봅니다.
[1] 이미 작성된 zbXE 공식 매뉴얼(스프링노트) 페이지 중에서 잘되었다 싶은 페이지들을 Link로 적어주시고... 장단점도 논의해봅시다.
[2] 외부 다른 매뉴얼 페이지중 참고할 만한 것을을 Link해서 함께 보고 배울점을 뽑아 정리하면 좋겠습니다.
Web에 있는 것이 아니라 어떤S/W의 Help 같은것도 좋구요.
관련주제
- [주제] 메뉴얼 작성자 지침서 : http://www.zeroboard.com/proj_doc/16438213
2008.02.13 13:48:36 (*.8.18.142)
![[레벨:9]](./modules/point/icons/default/9.gif "포인트:8080point (89%), 레벨:9/30"){kind=icon}
하늘03Textcube Manual Page: http://textcube.org/manual/
Trac Manual Page : http://trac.edgewall.org/wiki/TracGuide
도 참조하시면 좋을 것 같습니다.
Trac Manual Page : http://trac.edgewall.org/wiki/TracGuide
도 참조하시면 좋을 것 같습니다.
![[레벨:8]](./modules/point/icons/default/8.gif "포인트:7005point (96%), 레벨:8/30"){kind=icon}
bradly1
2008.02.16 02:03:13 (*.214.75.245)
![[레벨:4]](./modules/point/icons/default/4.gif "포인트:1530point (68%), 레벨:4/30"){kind=icon}
듀얼매니아+웹호스팅텍스트큐브가 아직까진 내용이 적긴해도 정리체계가 좋다고 봅니다.
좀 관련없다고 생각하지만 사용자메뉴얼,개발자메뉴얼 이렇게 분류보다는 설치법,스킨설치법,스킨제작법, 이런식으로 세분화한것을 첫메인에 보여주고 바로 원하는 결과를 보여주면 어떨까요. 혹은 더 복잡해질까요
이건 그냥 깔끔해서 적을뿐입니다.
http://www.w3.org/Consortium/siteindex#index
좀 관련없다고 생각하지만 사용자메뉴얼,개발자메뉴얼 이렇게 분류보다는 설치법,스킨설치법,스킨제작법, 이런식으로 세분화한것을 첫메인에 보여주고 바로 원하는 결과를 보여주면 어떨까요. 혹은 더 복잡해질까요
이건 그냥 깔끔해서 적을뿐입니다.
http://www.w3.org/Consortium/siteindex#index
특이하게 웹에서도 서비스하고있습니다. 속도는 좀 느리지만...^^
http://www.autodesk.com/us/maya/docs/Maya85/wwhelp/wwhimpl/js/html/wwhelp.htm
대분류는 이렇습니다.
- Learning Resources : 나름 특이한 대분류가 1순위로 나옵니다.
- What's New : 이전 버젼과 달라진 점들을 설명합니다.
- Using Maya : 우리로 치면 사용자매뉴얼 부분이 되겠습니다.
- Developer Resources : 우리로 치면 스킨제작매뉴얼 + 개발자매뉴얼 이 되겠습니다.
- 각종 Index(목차) : 변수, 함수 인덱스 등을 만들어 매뉴얼쪽으로 링크해주어 찾기 쉽게 만들어 주면 좋겠네요.
사실 Maya 책 없이 Help만 봐도 대략적인 기능들을 다 습득 할 수 있습니다. 물론 깊이는 좀 얕은 편입니다.초보들을 위한 기초설명 + 튜터리얼 형식의 레슨 들이 모여있습니다. 우리에게도 필요한 부분이 아닐까요?
공식매뉴얼이면서도 별도로 작성된 튜토리얼들을 모아주어도 좋을 듯 합니다.
문서의 형식도 상당히 단순해서 어떤점을 배워와야할지는 모르겠지만... 단순한것 자체가 좋기도 합니다.
설명을 주절주절 길지않게 간단히, 어떻게 보면 수박겉핥기 정도로 하기 때문에 단순할 수 있다고 보이기도 합니다.
그냥 참조를..^^