개발하다가, 하나 둘 씩 이렇게 블로그에 남기면 좋을 것 같아 오늘부터 시작하려고한다.
여러 메뉴얼 문서를 작성하다 보니까 브런치, 티스토리 중에 그래도 메뉴얼은 노션이 가장 적기 좋은 것 같다.
무슨 메뉴얼이 이렇게 많나 싶다.
일단 내가 노션을 선택한 이유는,
1. 최근에 메뉴얼 적는 걸 다 노션으로 하고 있길래
2. PDF 내보내기가 되고 깔끔하게 나온다.
물론 작성법은 사람마다 다르겠지만, 나 같은 경우엔 일단 표로 시작한다.
내용의 가장 위부터, 표로 수정이력을 남겨준다.
수정이력을 남겨야 최초작성일이 언제인지 알 수 있고, 너무 오래됐다면 내용이 좀 바뀌었겠네~ 라고 생각도 가능하다.
또한, 메뉴얼에 의문이 생겼을 때 작성 담당자에게 추가로 물어볼수 있는 것이고.
보통 우리 회사는 이름/담당자/날짜 순으로만 둔다.
좀 더 내용이 길어진다면 물론 상세하게 볼 수 있겠지만, 한정된 페이지 안에서 좁게좁게 나오느라 가시성이 좋지 않을거라고 생각했다.
그리고 저 1.2.3 번을 감싸고 있는 캡션으로 접었다 폈다 할 수 있어서, 본인이 원하는 부분만을 간편하게 다시 볼 수 있다.
오른쪽 스크롤 바를 보면 알 수 있듯이 제공하는 것들이 많다.
그리고 개발자들이 많이 쓰는 걸 아는지, 깃허브도 임베드 할 수 있다.
그 중에서 내가 가장 많이 쓰는 것은 이런 것들이다.
코드 는 많이 쓰긴하는데, 솔직히 티스토리,노션 둘 다 비슷비슷해서 단순하게 코드 백업용이라면
노션보다는 티스토리에 적는 것을 추천한다.
노션의 코드 기능은 어디까지나, 메뉴얼 작성 시에 코드가 일부분 들어가야할 때 적는 것 같다.
굳이 노션의 코드 기능이 좋아서, 노션을 굳이 사용한다 라는 사람은 일단 내 주변엔 없었다.
그리고, 오른쪽 상단에 있는 버튼을 눌러 내보내기를 선택하면 아래처럼 나온다.
내보내기 형식은 PDF가 무난한 것 같다.
'기타 개발관련 기록' 카테고리의 다른 글
DB명세서 작성법 (0) | 2021.08.24 |
---|