이 페이지는 Cloud Translation API를 통해 번역되었습니다.

ESLint 프로젝트

이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:: ESLint
테크니컬 라이터:: 카와르
프로젝트 이름:: 구성 재구성/재작성 문서
프로젝트 기간:: 표준 기간 (3개월)

Project description

개요

이 프로젝트의 목표는 ESLint의 구성 문서를 재구성하고 효과적인 정보 아키텍처를 만드는 것입니다. 이렇게 하면 탐색이 더 쉬워지고 문서의 사용성과 유용성이 향상됩니다.

프로젝트 요약 현재 상태의 ESLint 구성 문서 (https://eslint.org/docs/user-guide/configuration)는 단일 페이지에 많은 정보를 제공합니다. 페이지에 제목, 부제목, 적절한 문단이 있더라도 문서가 복잡하게 느껴질 수 있습니다. 특정 섹션에 관심이 있는 사용자에게 혼란을 줄 수 있는 페이지의 특정 섹션으로 이동할 수 있는 방법은 없습니다. 이러한 체계적인 조직의 부족으로 인해 정보가 손실되어 원하는 목적을 달성하지 못하고 사용자에게 추가적인 노력을 요구하게 될 수 있습니다.

그러나 이 문제는 일련의 신중한 단계를 통해 해결할 수 있습니다. 재구성의 첫 번째 단계로 콘텐츠 감사를 제안합니다. 콘텐츠 감사는 정보 표시의 문제를 식별하는 데 도움이 될 뿐만 아니라 콘텐츠 자체의 단점 (예: 오래되었거나 불완전한 정보)도 강조합니다. 그런 다음 정보 아키텍처 (IA)를 만들어 지식 네트워크를 공개할 계획입니다. 이를 통해 다양한 주제에 따라 정보를 클러스터링하고 밀접하게 관련된 여러 주제 간의 링크를 찾을 수 있습니다. 이러한 두 가지 방법을 통해 얻은 유용한 정보는 단일 페이지 문서를 여러 페이지로 나누는 데 사용됩니다. 그런 다음 마크다운에서 전체 패키지를 연결하고 상호 참조할 수 있습니다. 따라서 탐색하고 이해하기가 더 쉽도록 구성 문서가 더 잘 정리된 버전이 될 것입니다.

동기 오픈소스 소프트웨어를 사용한 지 얼마 되지 않았음에도 불구하고 이 용어를 친숙하게 느낀다는 사실은 제가 린트 소프트웨어에 대해 아는 것과 비슷합니다. 저는 (edX를 통해) Python을 배우기 시작했을 때 사소한 오류가 전체 코드를 어떻게 망칠 수 있는지 궁금했습니다. 코드를 테스트한 다음 오류를 확인해 보면 좋겠다는 생각이 들어서 '린트 처리'라는 용어를 알게 되었죠. 린트 소프트웨어를 제대로 사용해 본 적은 없지만, 이렇게 하면 앞으로 생활이 한결 수월해질 것이라는 확신이 듭니다.

전기 공학에 대한 배경지식과 프로그래밍 경험이 있으므로 코딩 문제와 프로그래머 요구 사항을 더 잘 이해할 수 있습니다. 또한 기술 및 전문 커뮤니케이션 대학원 학위 과정을 통해 사용자의 삶을 더욱 편리하게 만들 수 있었습니다. 저의 기술과 전문성이 이 프로젝트에 훌륭한 조합으로 기능하면서 ESLint 문서에 가치를 더할 것입니다.

목표 이 프로젝트의 중요한 목표는 ESLint 구성 페이지에 있는 문서가 이해하기 쉽고 사용자가 부담을 느끼지 않도록 하는 것입니다. 프로젝트의 성공을 위해서는 콘텐츠 탐색이 간편하고 복잡하지 않아야 합니다. 프로젝트의 중요한 목표는 다음과 같습니다. - 포괄적인 콘텐츠 감사 실시 - 정보 흐름을 이해하기 위한 정보 아키텍처 구축 - 정보 아키텍처를 개선하여 문서 재구성 - 콘텐츠의 여러 섹션 간 링크 및 참조 확인 - 필요한 경우 재구성 요구사항을 충족하도록 문서의 일부 재작성/수정

- 콘텐츠의 유연성과 재사용성 보장

프로젝트 설명 ESLint 구성은 ESLint를 맞춤설정할 수 있도록 하는 중요한 기능입니다. 구성에 관심이 있는 사용자는 한 번에 한두 가지 측면에 관심이 있을 것입니다. 따라서 관심 있는 특정 주제로 사용자를 안내하여 효율적인 방법으로 해결 방법을 제공하는 것이 중요합니다. ESLint의 현재 구성 문서 상태에는 유용한 정보가 많이 포함되어 있지만 사용자가 부담스럽거나, 좌절하거나, 길을 잃을 수 있는 방식으로 구성되어 있습니다. 예를 들어 ESLint에서 서드 파티 플러그인을 사용하는 법을 배우는 데 관심이 있는 사람이라면 아래로 스크롤하여 파서, 환경 및 전역 변수 지정에 관한 설명을 읽어야 합니다. 이러한 방법이 모두 지루하게 느껴지고 웹사이트를 떠나게 될 수 있습니다. 마찬가지로 사용자가 페이지 중앙에서 특정 섹션으로 이동하거나 유사한 주제를 살펴보고자 하는 경우 사용자에게 이러한 보조 도구가 제공되지 않으므로 이 작업은 쉬운 작업이 아닙니다. 문서가 얼마나 잘 작성되었든 유용성에 따라 문서 품질이 달라지기 때문에 이러한 문제는 즉각적인 주의가 필요합니다. 이어지는 논의에서 이러한 문제 및 기타 관련 문제에 대한 해결책을 제안합니다.

콘텐츠 감사 구성 문서를 재구성하는 과정의 첫 번째 단계는 포괄적인 콘텐츠 감사를 수행하는 것입니다. 감사는 오래된 콘텐츠, 중복, 콘텐츠 누락과 같은 주요 문제를 식별하는 것을 목표로 합니다. 그 결과 생성된 콘텐츠 감사 스프레드시트가 경영진 및 문서팀과 공유되어 의견을 받습니다. 그러면 문서를 구조화하고 제시하기 위한 새로운 전략을 고안하는 데 도움이 될 것입니다.

정보 아키텍처 만들기 구성 문서의 지식 네트워크 또는 정보의 흐름을 이해하려면 정보 아키텍처 (IA)를 만드는 것이 중요할 수 있습니다. 콘텐츠 감사 결과는 정보 흐름을 이해하고 발전시키는 데 좋은 토대가 될 것입니다. 그러면 향상된 버전의 IA가 생성되어 문서를 더 나은 방식으로 구성하고 제공합니다. 이렇게 개선된 IA를 통해 현재 콘텐츠를 재구성할 뿐 아니라 문서의 다양한 섹션 간 링크와 포크를 식별하여 효율적인 네트워크를 구축합니다. 예를 들어 '규칙 구성'에 관한 콘텐츠 다음에 '인라인 댓글로 규칙 사용 중지'로 이어지는 링크가 있을 수 있습니다. 다른 링크도 식별할 수 있으므로 문서의 여러 섹션 간에 관계가 형성됩니다.

목차 콘텐츠 감사와 IA는 문서의 특정 섹션과 하위 섹션으로 연결되는 링크가 포함된 자세한 목차를 만드는 데 필요한 정보를 제공합니다. 섹션마다 별도의 파일을 만들고 다른 섹션에 적절한 참조를 추가하면 전체 문서에 가치를 더할 수 있습니다. 구성 문서를 방문하는 사용자를 위해 목차를 만들 수 있으므로 웹사이트에 있는 사용자의 여정에 도움이 됩니다. 목차에는 간단하면서도 포괄적인 제목을 제공하기 위해 첫 번째 수준과 두 번째 수준의 제목을 모두 포함할 수 있습니다. 예를 들어 Prettier (https://prettier.io/docs/en/index.html)에서 문서를 구성할 때 사용하는 방법이 있습니다.

모든 문서는 마크다운을 사용하여 간결하고 잘 정리된 상태로 작성됩니다. 향후 확장되거나 변경될 수 있으므로 문서가 재사용될 수 있도록 특별한 주의를 기울여야 합니다.

도구

- 문서의 버전 제어를 보장하는 GitHub

마일스톤 제안 제출부터 프로젝트 완료에 이르기까지 다음 잠정적인 주요 단계를 사용하면 프로젝트가 제때 완료되어 올바른 흐름을 유지할 수 있습니다.

2020년 7월 10일~2020년 8월 16일: 제안 검토 및 선택 ESLint 문서를 살펴보고 프로젝트를 완료하는 데 필요한 기술 (예: 마크다운 작성, GitHub 공동작업)을 개발하겠습니다. 또한 GitHub를 통해 문서에 기여하고 다른 사용자와 소통하여 문서에 대한 이해를 높일 것입니다.

2020년 8월 17일~2020년 9월 13일: 커뮤니티 유대감 커뮤니티 유대감 형성 기간 동안 멘토 및 관련 팀과 논의한 내용에 따라 제안서를 다듬을 예정입니다. 필요한 경우 목표와 마일스톤도 수정합니다. 또한 프로젝트 작업에 사용할 도구를 추후에 선정해 보겠습니다.

2020년 9월 14일~2020년 9월 19일: 콘텐츠 감사 프로젝트를 시작하기 위해 구성 문서에 대한 포괄적인 콘텐츠 감사를 실시할 예정입니다. 목표는 콘텐츠와 프레젠테이션의 문제를 강조하는 것입니다.

2020년 9월 20일~2020년 9월 25일: 정보 아키텍처 (IA) 콘텐츠 감사 후 구성 문서의 IA를 만듭니다. 저는 지식 네트워크를 이해하기 쉬운 방식으로 표현하는 데 집중할 것입니다. 이렇게 하면 정보의 흐름을 개선하는 데 도움이 됩니다.

2020년 9월 26일~2020년 9월 30일: 링크 및 참조 이 단계에서 IA를 분석하여 문서의 다양한 섹션 간 링크와 참조를 매핑하겠습니다. 또한 모든 섹션의 계층 구조를 생성하여 프로세스의 IA를 개선할 것입니다.

2020년 10월 1일~2020년 10월 3일: 최종 지도 콘텐츠 감사 및 IA를 통해 얻은 유용한 정보를 활용하여 재구성된 구성 문서에 구현할 최종 지도를 만듭니다. 이 포괄적인 지도에는 목차, 주제의 계층 구조, 문서 섹션 간의 링크 및 상호 참조 목록이 포함됩니다.

2020년 10월 4일~2020년 10월 5일: 토론 이제 문서를 수정하기 전에 발견한 내용과 계획을 멘토와 해당 팀에 설명하겠습니다. 그들의 피드백은 계획을 다듬고 필요한 경우 수정하는 데 도움이 됩니다.

2020년 10월 6일~2020년 10월 20일: 재작성 및 수정 이 기간 동안 작업이 필요한 문서 섹션을 수정하고 업데이트할 예정입니다. 구성 문서의 일부 섹션이 다시 작성되거나 새로운 내용이 추가될 수 있습니다. 이 단계에서는 문서가 정확하고, 업데이트되고, 유연하고, 재사용 가능하도록 하는 데 중점을 둡니다.

2020년 10월 21일~2020년 10월 25일: 수정 및 링크 이 단계에서는 직접 작성한 작업을 검토하여 문법 및 구조적 오류를 없애고 작업 내용이 정확한지 다시 확인합니다. 또한 IA에 따라 섹션 간에 링크와 참조를 추가하여 문서가 앞서 고안된 지식 맵을 따르도록 할 것입니다.

2020년 10월 26일~2020년 10월 31일: 제출을 위한 최종 버전 모든 마크다운 파일을 연결하고 목차를 만든 후 초안을 멘토와 공유합니다. 이렇게 하면 첫 번째 초안을 완전한 패키지 형태로 제출할 수 있습니다.

2020년 11월 1일~2020년 11월 5일: 1차 검토 이 5일 동안 멘토와 첫 번째 초안에 대해 논의할 예정입니다. 팬들의 의견을 받고 내 아이디어에 관해 논의하며 수정해야 할 수정 목록을 작성합니다.

2020년 11월 6일~2020년 11월 12일: 첫 번째 수정 멘토의 의견을 바탕으로 문서의 첫 번째 초안을 수정합니다. 실제 수정사항은 댓글과 피드백의 성격에 따라 다르지만, 재사용, 정확성, 유연성의 목표가 수정 단계의 중심 역할을 합니다.

2020년 11월 13일~2020년 11월 15일: 2차 검토 초기 수정을 완료한 후 멘토 및 해당 팀과 진행 상황에 대해 한 번 더 논의할 예정입니다. 이러한 토론은 첫 번째 버전의 수정사항에 초점을 맞추고 수정 과정에서 발생할 수 있는 다른 문제도 함께 조명합니다.

2020년 11월 16일~2020년 11월 19일: 두 번째 수정 그런 다음 4일 동안 문서를 수정하겠습니다. 그 결과로 제작된 버전은 멘토와 상의하여 최종 형태를 만듭니다. 이 단계가 완료되면 문서는 최종 형태가 되어 웹사이트와 GitHub 저장소에 업로드할 수 있습니다.

2020년 11월 20일~2020년 11월 23일: 웹사이트에서 업로드 필요한 모든 수정이 완료되면 문서가 웹사이트에 업로드됩니다. 이 과정에서 발생한 모든 문제는 그에 따라 처리되며, 문서 검토에 며칠이 소요될 수 있습니다.

2020년 11월 24일~2020년 11월 28일: 프로젝트 보고서 이 5일 동안 프로젝트 상세 보고서가 생성됩니다. 제시된 목표, 어려움, 문제 및 솔루션은 프로젝트 보고서의 일부를 구성합니다. 보고서는 의견 제공을 위해 멘토와 공유됩니다.

2020년 11월 29일~2020년 11월 30일: 최종 제출 프로젝트 및 모든 파일, 프로젝트 보고서를 멘토에게 제출합니다. 전체 프로젝트에 대한 검토는 멘토 및 해당 팀과의 미팅/토론을 통해 이루어집니다.

프로젝트를 진행하는 동안 멘토와 계속 상의하여 귀중한 피드백을 받을 것입니다. 모든 주요 일정은 커뮤니티 유대감 및 제안서 검토 기간에 멘토와의 토론에 따라 변경될 수 있습니다.

자기소개 노스캐롤라이나 주립대학교에서 전기 공학 학사 학위 및 기술 및 전문 커뮤니케이션 석사 학위를 받았습니다. 기술 및 전문적인 글쓰기 및 편집, 커뮤니케이션 및 콘텐츠 관리, 웹 및 모바일 사용 편의성 연구, 수업 설계 분야에서 경험이 있습니다. 저는 온라인 출판물(Global Village Space)의 부편집자 및 듀크 대학교(Duke University)에서 커뮤니케이션 인턴으로 일했습니다. 그뿐만 아니라 창의적인 글쓰기에도 관심이 있습니다.