분류 전체보기
-
[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. 서..
-
Technical writing Two - 문서 구조화 하기 (1)문서 유형과 개요Technical Writing 2022. 2. 22. 21:23
몇 백 페이지가 넘어가는 문서를 작성할 때 어떻게 문서를 구조화할 수 있을까요? 이번 포스팅에서는 구글 Technical writing two 과정에서 제공하는 문서 구조화하는 방법에 대해서 공부해보고 제 의견을 덧붙여 보려고 합니다. 문서 유형 구분하기 문서의 유형에 따라 긴 독립형 문서 혹은 상호 연결된 짧은 문서로 구성할 수 있습니다. 일반적으로 제조업에서 제공하는 장비 매뉴얼과 같은 문서는 긴 단일 문서로 구성되어 있습니다. IT업계에서 제공하는 개발 사이트나 위키와 같은 형식으로 구조화된 문서는 상호 연결된 짧은 문서로 구성되어 있습니다. How-to 가이드, 제품 소개 문서, 개념 가이드는 제품이나 서비스를 처음 접하는 독자를 대상으로 할 때 더 효과적이며 짧고 간략하게 작성해야 더 효과적이라..
-
초보자를 위한 API가이드, API란 무엇일까?카테고리 없음 2022. 2. 21. 20:53
IT업계로 도전하고 싶어 공부 중에 있습니다. (기존에 Notion으로 작성된 내용을 조금씩 수정해서 티스토리에 업데이트 중입니다.) IT업계에서는 테크니컬 라이터가 API가이드를 작성한다고 하는데 API가이드가 뭐지?라는 궁금증이 생겼습니다. API가이드에 대해서 제일 친절하게 설명한 아티클 있어 제 의견을 덧붙여 번역해보고자 합니다. 원문은 페이지 하단에서 확인할 수 있습니다. 🎈오역과 의역이 있을 수 있습니다. 애플리케이션이 서로 어떻게 소통하는지 궁금한 적이 있으신가요? 애플리케이션은 Application Programming Interface(API)를 사용해 서로 대화합니다. 스포티파이를 통해 음악을 듣거나 넷플릭스에서 시청할 때마다 우리는 API를 간접적으로 사용하고 있습니다. 이 기사에서는..
-
Technical writing One - 간결하게 문장 작성하기Technical Writing 2022. 2. 15. 20:48
이번 포스팅에서는 테크니컬 라이팅 4원칙 중 간결성에 대해서 설명해보려고 합니다. 간결성이란 무엇일까요? 간결성이란 특정 독자가 정보를 빠르게 이해하도록 미사여구를 사용하지 않고 쉽고 간결한 쉬운 단어를 사용하는 것입니다. 소프트웨어 엔지니어는 다음과 같은 이유로 코드 줄 수를 최소화하려고 합니다. 일반적으로 코드가 짧을수록 다른 사람들이 읽기 쉽습니다. 짧은 코드는 긴 코드보다 유지 관리하기가 쉽습니다. 긴 코드라인은 에러 발생 확률이 높습니다. 기술문서를 작성할 때도 동일합니다. 짧은 문서는 긴 문서보다 더 빨리 읽히고, 가독성이 좋습니다. 하나의 문장에 하나의 주제만 작성하기 기술문서에서 지나치게 긴 문장은 독자에게 혼란을 줄 수 있습니다. 가급적이면 하나의 문장에 하나의 주제만 작성하기를 권장합니..