전체 글
-
API 문서화 공부하기 1 - API문서의 필요성과 REST APIAPI 2022. 5. 2. 21:23
API 공부하기 좋은 사이트를 발견해서 이번에는 API 문서화에 대해서 공부해보려고 한다! 내 분야는 아니어서 많은 공부를 해봐야 될 것 같다. 이제까지 내가 작성해왔던 제조업에서의 일반적인 GUI 설명서와는 많이 다르다는 것이 느껴진다.🙄 예를 들어 이제까지 배포해왔던 파일은 PDF 형식이라면 API문서는 주로 웹 형식으로 배포된다는 차이도 있고.. 어쨌든 API에 대해서 대충 개념은 알고 있으니 이제 실습을 해볼 차례다. 왜 TW가 API를 공부해야 할까? 첫 번째로는 대규모 시스템 대신 웹사이트는 API를 통해 필요한 서비스를 제공하고 있다. 예를 들어 웹사이트에서 로그인 기능을 만드는 대신 카카오 로그인 서비스를 사용할 수 있다. 실제로도 많은 서비스에서 API를 통해 정보와 도구를 제공하고 있다..
-
[Git blog 만들기] - 2. Git에서 자주 쓰이는 커맨드 정리git과 Markdown 2022. 4. 20. 21:07
지난번 포스팅에서는 git의 기본 커맨드에 대해서 알아봤다면 이번 포스팅에서는 git에서 자주 사용되는 커맨드의 아주 기본! 에 대해서만 간단하게 정리해보려고 한다. 해당 커맨드에 대해서 자세하게 설명하려면... 끝도 없을 것이다. 해당 커맨드에서 대해서 더 많은 정보가 궁금하다면 역시나 깃 공식 홈페이지를 참고하면 된다! 아주아주 잘 정리된 문서를 확인할 수 있다. git 도움말 불러오기: git help git 커맨드에 대해서 도움이 필요할 때 구글링으로 검색하면 많은 해답을 찾을 수 있지만 git help 커맨드를 사용해 빠르게 확인할 수도 있다. $git help $git help [커맨드 입력] // 사용법이 궁금한 git의 커맨드를 입력합니다. 매뉴얼의 내용을 출력합니다. 실제 출력되는 화면은..
-
[Git blog 만들기] - 1. Git의 필요성과 Git 기본 개념git과 Markdown 2022. 4. 5. 20:40
한동안 git blog 만드는 일에 빠져있어서 포스팅을 못했다.😅 git을 처음 사용해보기 때문에 어려움도 많았지만 구글링을 해보면 git과 관련된 자료가 아-주 아주 아주 x 100 많아서 스스로 정리하면서 개념을 정리해보고자 한다. Git 왜 필요할까? 처음에 git을 알게 되었을 때는 개발자들만 사용하는 줄 알았다. 하지만 테크니컬 라이터에 관심을 가지게 되고 실제로 모 it 기업에 면접을 보러 갔을 때 'git을 사용해 보셨나요?'라는 질문을 들었고, 나는 사용해보지 못했다고 대답을 했다. 그때부터 '아 테크니컬 라이터도 git을 다뤄보는 게 좋겠구나!'라는 생각이 들었다. 다행히도(?) git을 사용해보지 않았다고 면접에서 떨어지진 않았지만 우대사항에 들어가는 git을 나도 공부해보면 좋지 않을..
-
[UI/UX 컴포넌트 공부하기] - 모달(Modal)UX Writing 2022. 3. 21. 16:15
모달(Modal) 이란? 모달(modal)이란 일반적으로 기존 화면 위에 플로팅 되는 화면을 의미합니다. 사용자가 새 페이지로 이동할 필요 없이 기존 화면에 중요한 정보를 표시할 수 있습니다. 또한 모달을 활용하면 플로팅 된 화면과 아래 화면의 관계를 통해 보다 명확한 워크 플로우를 제공할 수 있습니다. 🔎모달 구성 요소 아래 그림을 통해 모달을 구성하고 있는 요소들을 살펴보겠습니다. 배경 모달상자 제목: 제목은 모달의 목적을 분명하고 간결하게 설명합니다. 콘텐츠 영역 버튼: 버튼을 사용하면 헤드라인 질문에 답할 수 있습니다. 버튼 레이블은 동작 기반의 동사로 작성하여 기능과 결과를 명확하게 전달할 수 있도록 합니다. 버튼의 경우는 제목이나 콘텐츠에 사용되는 단어로 작성하는 것이 좋습니다. '사진을 휴지..
-
Technical Writing Two - 문서 구조화 하기 (2) 목차와 탐색Technical Writing 2022. 3. 19. 14:07
Google Technical Writing 과정 정리의 마지막 포스팅입니다. 문서의 구성이 좋다는 것은 기술 문서의 사용자가 필요한 내용을 빠르게 찾고 이해하기 쉽도록 각각 주제들이 논리적으로 연결된 것을 의미한다고 합니다. 이번 포스팅에서는 문서를 구조화할 때 목차를 어떻게 작성해야 하는지 탐색 기능을 왜 추가해야 하는지에 대해서 작성해보려고 합니다. 목차 목차는 기술문서의 필수 요소로써 독자에게 기술문서의 구성을 한눈에 보여주는 아주 중요한 역할을 합니다. 5장 이내의 짧은 문서라면 목차를 반드시 작성하지 않아도 되지만 매뉴얼과 같이 몇 백 페이지가 넘어가는 긴 문서는 목차를 작성해주어야 독자가 피요한 정보를 빠르게 찾을 수 있습니다. 매뉴얼 작성 시에 항상 생각해야 하는 것 중에 하나는 긴 매뉴얼..
-
[UI/UX 컴포넌트 공부하기] - 툴팁(Tool Tip)UX Writing 2022. 3. 7. 16:56
UI/UX Writing hub에서 무료로 UX Writing 맛보기 과정을 제공하고 있습니다. 해당 사이트에서 제시한 과정을 토대로 배운 내용들을 정리하고자 합니다. 해당 과정은 무료로 진행되기 때문에 아주 짧은 글로 구성되어 있지만 저에게 공부할 할 주제를 준다는 게 마음에 듭니다🤗 이번 포스팅에서는 UI/UX 요소 중에 하나인 툴팁(Toop Tip)에 대해서 정리해보려고 합니다. 툴팁이란? 입력 필드나 인터페이스에 관한 복잡한 내용을 설명하고 싶을 때 레이블 옆에 작은 i 아이콘 혹은 ? 아이콘을 배치하고 여기에 마우스가 올라갈 때 설명이 들어간 툴팁이 나타납니다. 즉, 툴팁은 사용자가 요소 위에 마우스 커서를 올릴 때 표시되는 텍스트 레이블입니다. 툴팁을 사용하면 어떤 기능인지 그리고 이 항목이 ..
-
Technical Writer가 UX Writing을 공부하는 이유사담 2022. 2. 28. 20:50
📝UX Writing과 UX 디자인에 대해서 공부하고 있습니다. UX Writing의 중요성이 점점 증가하고 있고 기술 문서 작성과 사용자 경험은 겹치는 부분이 많음을 느낍니다. 이번 포스팅에서는 왜 Technical Writer가 UX Writing을 공부하는지 시너지 효과는 무엇인지 작성해보려고 합니다. 🤗 먼저 기술문서 작성의 목표는 제품이나 서비스를 어떻게 사용하는지, 동작하는지 쉽게 이해할 수 있도록 하는 것입니다. 테크니컬 라이터가 사실 제일 많이 하는 작업은 글을 쓰는 것보다 자료를 이해하고 취합하는 일이 아닐까 싶습니다. 즉, 개발자나 엔지니어가 작성한 복잡한 문서를 이해한 후에 이를 구조적이고 짜임새 있게 만드는 것입니다. Technical Writing과 UX Writing의 공통점? ..
-
Technical Writing One - 목록 올바르게 사용하기Technical Writing 2022. 2. 24. 20:30
기술문서에는 가독성을 높이기 위해 목록이 자주 사용됩니다. 이번 포스팅에서는 Google Technical Writing 과정을 참고하여 목록의 유형에 대해서 알아보려고 합니다. 목록의 유형 기술문서 작성 시에 사용되는 목록의 유형은 다음과 같습니다. 글머리 기호 목록 번호 매기기 목록 포함된 목록(쉼표로 나열한 형태) 글머리 기호 목록은 항목의 순서를 변경해도 목록의 의미가 변경되지 않습니다. Bash는 다음과 같은 문자열 조작 메커니즘을 제공합니다. - 문자열 시작 부분에서 부분 문자열을 삭제합니다. - 전체 파일을 하나의 문자열 변수로 읽습니다. 하지만 번호 매기기 목록은 항목의 순서를 변경하면 의미가 변경되므로 목록에 번호를 매겨 작성합니다. 서버를 재구성하려면 다음 단계를 수행하십시오. 1. 서..