2 posts tagged with "document"

최근 React JS의 공식문서가 리뉴얼되고 있다는 소식이 종종 들립니다.(beta.reactjs.org) 이전 문서에서도 불만은 없었던터라 왜 리뉴얼을 했을지 궁금했습니다. 리액트팀의 운영 기조(트렌드)가 바뀌었을까? 아니면 과거 문서에 문제점이 있었을까?

가끔 블로그 글을 적거나 프로젝트를 하면서 markdown으로 PR description이나 comment를 남길 때 복잡도 있는 내용을 설명할 때 너무 많은 텍스트를 작성해야할 경우가 있습니다. 그 때마다 다이어그램을 그려서 캡쳐를 하거나 gif를 만들어서 설명에 함께 첨부하는 것이 이해를 도와주곤 합니다. 하지만 시간이 지나면서 그 다이어그램에 부가적인 요소를 추가하거나 수정사항이 생기면 다시 이미지를 만들어야하는 귀찮은 상황이 발생합니다. 결국 이런 귀찮음은 문서화를 소홀히하게 되는 원인이 되곤합니다. (그 이외에도 이유는 많긴합니다.)

이런 문제를 해결하기 위해 다른 팀원들과 수정가능하고 히스토리를 기억할 수 있는 mermaid라는 도구를 학습해보려합니다.