일을할때 문서화하는 요령좀 알려주세요.

k1d0bus3의 이미지

자영업합니다.

지금은 os를 수정하여 설치/테스트 하는 프로젝트하고 있습니다.

몇개월째 하다보니 과거에 해놓았던 작업들을 까먹어서, 다시하는일이 너무 많습니다.

프로그래밍작업은 거의없습니다. 기껏해야 셀스크립트만들어넣고, 원본 소스코드 조금씩 수정하는 정도입니다.

테스트는 많이 합니다.

일의 비율은 개발:개발이아닌일=4:6 정도 됩니다.

지금까지는 온라인상에서 구글캘린더+구글task+구글drive에 기록하고, 오프라인으로 메모하는걸로 모든걸 관리해왔는데,

plan+지금껏한작업+잡다한작업들이 뒤죽박죽되어 벅찹니다.

문서화 방식은 온라인이든 오프라인이든 관계없는데, 좋은 요령있으면 알려주세요.

shint의 이미지

저 역시도 관리는 어렵습니다.

저는 소스 코드가 많습니다.
이것저것 다운받고 설치하다보니. 관리하기 어렵습니다.

저는 하드에 폴더 단위로 관리하는데요.

- program
  - apmsetup
- util
  - 상용 유틸
  - 무료 유틸
  - 개발 유틸
  - 일반 유틸
- web
  - 연월일 홈피
  - 연월일 홈피
- dev
  - share 공유 폴더 (현재는 이렇지만. 나중에는 각 폴더별 share를 하는게 좋다는 생각도 듭니다.)
    - win
    - linux
    - qt
    - 구글 driver
  - o_s 오픈 소스
  - test 테스트 소스
    - tutorial
  - project 프로젝트
  - win 윈도우 소스
    - network
    - gui
    - 3d
    - 기타 등등
  - linux 리눅스 소스
    - network
    - gui
    - 3d
    - 기타 등등
  - document
  - vm virtual box
- shint 개인 자료
  - desktop
  - 사진
  - 음악
  - 애니
  - 게임

보는 형식은 트리'가 가장 좋습니다.
MFC 구조도를 참고해보세요. http://sonhy1.tistory.com/44

일정으로 볼때는. 리스트와 시간으로 분리하는것이 좋습니다.

폴더에 작업 내역을 적고. 구분하기 쉽도록 설명서 문서도 첨부하면 좋습니다.

everything 이라는 매우 빠른. 폴더 검색 프로그램이 있습니다. (옵션 설정 잘해야. 리로딩이 적어집니다.)
http://arserk.blog.me/40173571447

저 같은 경우는 이렇게 사용하지만...
DB등으로 파일화하거나. ISO나 클라우드. 가상PC등을 응용하는 방식도 있어 보입니다.

----------------------------------------------------------------------------
젊음'은 모든것을 가능하게 만든다.

매일 1억명이 사용하는 프로그램을 함께 만들어보고 싶습니다.
정규 근로 시간을 지키는. 야근 없는 회사와 거래합니다.

각 분야별. 좋은 책'이나 사이트' 블로그' 링크 소개 받습니다. shintx@naver.com

bt의 이미지

정리 잘 하시네요.

이처럼 트리로 관리하는게 가장 좋은 방법입니다. 이렇게 저렇게 해보다보면 이 분야의 실력도 늘어납니다. 업무를 효율적으로 해줄 수 있는 중요한 스킬이죠.

자료들은 검색도 되는 환경에 올려놓으면 더 좋겠지요.

shint의 이미지

.emf 기획 및 구상 이미지 배포
.odg 오픈 오피스 그리기

dev c++로 .c를 .html로 배포

----------------------------------------------------------------------------
젊음'은 모든것을 가능하게 만든다.

매일 1억명이 사용하는 프로그램을 함께 만들어보고 싶습니다.
정규 근로 시간을 지키는. 야근 없는 회사와 거래합니다.

각 분야별. 좋은 책'이나 사이트' 블로그' 링크 소개 받습니다. shintx@naver.com

oosap의 이미지

저는 미디어 위키를 쓰고 있습니다.
그런데 최근에는 Sphinx 를 보고 있습니다.

What users say:
“Cheers for a great tool that actually makes programmers want to write documentation!”

http://sphinx-doc.org/index.html

http://matplotlib.org/sampledoc/

http://jong10.com/post/30221511694

Sphinx 는 github 에서 gh-pages 브랜치로 웹사이트화 할 수 있어 배포를 염두에 둔다면 아주 좋은 선택이 될 것 같습니다.

http://lucasbardella.com/report/hosting-your-sphinx-docs-in-github/

(이 방법엔 조금 보완이 필요합니다. 혹 누군가 요청을 하신다면 제가 수정본을 올릴 수도 있습니다.)

저도 아직은 초보입니다.

Thanks for being one of those who care for people and mankind.
I'd like to be one of those as well.

iamt의 이미지

저는 같이 쓰는사람들한테 위키 문법가르쳐야 돼서 너무 불편하던데..

---------------------------------------------------------------------------------
C(++)과 php 펄등을 공부하고있습니다.
반갑습니다! 리눅스 :-)

oosap의 이미지

저에게 질문하신 것이죠? 지금에서야 글 올리신 것 봤습니다.

저는 다른 사람에게 가르쳐 본 적은 없고 그냥 메뉴얼로 가는 링크만 전달합니다. 다른 위키들도 비슷하겠지만 미디어 위키는 사용법이 쉽습니다.

http://www.mediawiki.org/wiki/Help:Contents/ko

http://ko.wikipedia.org/wiki/위키백과:위키문법_요약

Thanks for being one of those who care for people and mankind.
I'd like to be one of those as well.