MSDN 처럼 문서 작성하기
→ 위키처럼.. 단어나 문장에 하이퍼링크 달기.
→ GIT에 마크다운으로 올리면 비슷하게 된다.
→ 사용 예제 적기 (우리 문서에는 예제가 없어 예제가!!)
→ 함수 원형
→
마케팅 문서 : 대외적으로 보여지는 문서. 장단점을 잘 정리한 문서가 필요
API 문서 : 나의 함수와 변수가 무엇을 의미하고 어떻게 쓰는지
래퍼런스 문서 : 사용법
목표 : 간결하게
요약 : 내 코드에 대한 설명과 장단점이 들어가야한다.
클래스 다이어그램 : 내가 왜 이렇게 짰는지 알려줘야함. ('클래스' 다이어그램 인 이유가 있다. 클래스 별로 나누기)
순서도 : 클래스 다이어그램을 이해시키기 위해 필요한 문서.
개념도 : 어떻게 할 것인지. 말을 풀어서 쉽게 설명. 누가 봐도 쉽게!
클래스 단위의 설명이 나와야 한다.
중명 : 내가 주장하는 근거들(위의 내용)을 바탕으로 다시 한 번 주장, 증명. 나의 생각, 의견을 쓰고 좋다는 것을 어필.
[꿀팁]
구글 학술검색
하이퍼 링크 달기
zotero 앱 활용하기 (익숙해지면 완전 편하다 → 논문 인용할 때 편함)
요점만!!