오픈소스 시대에 개발자라면 본인이 진행하였던 프로젝트 관련 개발일지를 개인 블로그나 온라인 문서로 남기는 게 좋다 라는 조언들이 자주 있었다.
사실 조언 받기 이전부터 docx나 hwp 파일로 나만이 알아볼 수 있는 짧은 형식의 보고서를 쓰긴 하였지만, 이제는 gist 에 전부 남겨 보려 한다.
이를 통해 단순히 커밋만 되어 있는 프로젝트들을 문서화된 내용으로 좀 더 많은 사람에게 디테일하게 공유하고 시간이 지나면 나 자신도 잊게 될 내용을 다시 한번 떠올릴 수 있는 복습용으로도 쓰이지 않을까 싶다.
또한 md 파일 형식으로 작성해 나갈 계획이라 프로젝트 저장소 README.md 에만 간략하게 쓰던 마크다운 문법을 좀 더 자유자재로 다룰 수 있을 것으로 기대된다.
1. 프로젝트 개요
2. 프로젝트 구조 & 리소스
3. 개발 내용
4. TMI
자료 등이 없어 첨부가 불가능한 메뉴는 기재 X
#include stdio.h
int main()
{
printf("Hello World!");
return 0;
}
md 안에서 소스 코드 내용을 기재할 땐 위와 같이 코드 블럭기능을 이용해 기재
.py .js 같이 확장자명을 통한 소스 파일 채로 내용을 업로드 할 시에는 새롭게 알게 된 방식이나 기존의 소스에 좀 더 최적화된 내용을 꾸준히 업데이트하여 비교분석이 가능하게 할 것
아무튼 해보자