[Docs] 프로젝트 개요 문서 작성

[yonghyeun]

개발을 시작한 계기

문서 작업 시 레퍼런스를 위해 저장한 웹 페이지의 문서들을 관리하는데 있어 불편함을 느꼈다.

일반적으로 내가 문서를 작업 할 때 레퍼런스들을 어떻게 정리하는가를 생각해보면

1. 브라우저 새 창을 만들어두고 해당 창에 레퍼런스 삼을 문서들을 여러개의 탭으로 저장해둔다.
2. 문서를 쭉 작성 한 후 가장 마지막 하단에 해당 브라우저 탭의 url 들과 포스팅 제목을 일일이 복사해서 - 제목 : url 의 형태로 붙혀넣었다.

이런 과정에서 느낀 불편함들이 존재했는데 다음과 같은 부분들에서 불편함을 느꼈다.

1. 레퍼런스들을 저장하기 위해 포스팅하기 위해 켜둔 브라우저 외에 별도의 브라우저 창을 하나로 더 띄워놔야 했다는 점
2. 레퍼런스 목록들이 인용된 문구의 위치와 상관 없이 매 번 최하단에 존재하여 , 레퍼런스 목록을 보았을 때 해당 레퍼런스의 어느 부분을 인용해서 내가 어떤 문구를 썼는지 추적하기 힘들었다는 점
3. 매 번 수동으로 레퍼런스 삼는 웹 문서의 제목과 url 을 복사해야 했다는 점

기존의 방법으로 해당 불편함을 해결하는 방법 (레퍼런스 저장)

이 문제들을 기존의 방법들로 해결하기 위해서 북마크를 이용하는 방법이 있을텐데 포스팅을 위해 게시글을 저장하는 행위를 위해 북마크를 이용하는 것이 불편했다.

북마크로 저장 된 데이터들은 휘발성이 약하기에 포스팅 이후에도 북마크에 남아있게 될 것이다.

매 번 레퍼런스 삼을 문서들을 북마크에 저장 하고 나서 지우지 않게 된다면 높은 확률로 다시 들어가보지 않을 링크들이 북마크에 리스트로 쌓이게 될 것이다.

포스팅 할 때 레퍼런스를 적절한 위치에 남겨 둔다면 , 내가 작성했던 게시글에서 어떤 내용을 다시 살펴보고 싶은 경우를 상상해보자

그런 경우에 북마크 리스트들을 모두 살펴보는 것 보다 내가 작성했던 게시글을 찾고 해당 게시글의 레퍼런스를 찾는 플로우가 훨씬 자연스럽다.

기존의 방법으로 해당 불편함을 해결하는 방법 (레퍼런스 작성)

레퍼런스를 작성하는 방법은 사실 기존의 방법으로 해결하는 방법은 없다.

내가 원하는 레퍼런스 표기법은 다음과 같다. (이는 변경 될 수 있다)

치킨의 근본은 BBQ의 황금올리브이며 이는 자명한 사실이다.[[1]](해당 레퍼런스의 url)
출처
[1] "레퍼런스 제목" : url

마크다운 문법을 지원하는 곳에선 하이퍼링크를 첨부하고 , 마크다운 문법을 지원하지 않는 곳에선 단순히 [number] 형식으로 작성하고 하위에서 레퍼런스의 번호를 남겨두는 방식으로 포스팅 하고 싶다면 매번 손수 위 과정을 반복해야만 한다.

목적

문서 작성 시 레퍼런스 삼을 웹 문서들을 효과적으로 일시적으로 저장 하며 레퍼런스를 포스팅 할 때 편하게 작성 할 수 있도록 한다.

목표

• 확장 프로그램 아이콘을 클릭하면 레퍼런스 삼을 문서의 정보들을 저장한다.
• 저장 된 레퍼런스 문서들을 이용해 문서 작성 시 참고 가능하도록 한다.
• 작성 중인 게시글에서 레퍼런스를 인용한 문구 옆에 '[number]' 로 표기한 경우 마크다운 문법을 지원하는 경우엔 하이퍼링크를 첨부 할 수 있도록 변환한다.

기능 개발 범위

핵심 기능

• 확장 프로그램 아이콘을 클릭하면 레퍼런스 삼을 문서의 meta 태그를 조회하여 문서의 정보를 저장한다.
• 확장 프로그램 아이콘을 클릭하여 사이드바나 팝업에선 전체 문서, 사용한 문서 등으로 나눠 레퍼런스들을 관리 한다.
• 사용한 문서들을 기준으로 하여 포스팅 된 게시글의 [number] 문구를 하이퍼링크가 첨부된 [[number]](링크) 형태로 변환한다.
• 사용한 문서들의 리스트를 클립 보드에 복사하여 게시글 하단에 붙여넣을 수 있도록 한다.

범위 외 기능

• 레퍼런스 문서 박스에서 메모 기능
• 마크다운을 지원하는 페이지에서 '[number]' 를 발견한다면 사용하는 레퍼런스 목록을 이용해 자동 변환 기능
• 레퍼런스 삼았던 문서를 history 형태로 저장하기 위해 북마크와 연동
• 팝업이나 사이드바에서 opacity 조절