이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- 매트플롯립
- 테크니컬 라이터:
- 예로메프
- 프로젝트 이름:
- 매트플롯립 입력 경로 개발
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
소개
올해의 Google 문서 시즌에 대한 매트플롯립의 프로젝트 제안에는 신규 사용자에게 매트플롯립을 소개하는 데 도움이 되는 콘텐츠 제작이 포함됩니다. 매트플롯립 입력 경로 개발의 경우 현재 문서의 접근 방식을 대체하는 접근 방식을 제안합니다. 저는 업계의 새로운 테크 작가이지만 교육 및 교육 관련 분야에서 경력을 쌓았습니다. 기술 글쓰기와 교육은 공감을 표현하고 사용자가 제공된 리소스로 작업을 완수할 수 있도록 하는 콘텐츠를 제작하는 데 중점을 두는 상당한 유사점을 가지고 있습니다.
이러한 맥락에서 매트플롯립 문서는 신규 사용자에 대한 공감을 개선함으로써 도움이 될 수 있습니다. 현재 대부분의 자료는 무작위 데이터와 라벨이 없는 시각 자료로 구성되어 있습니다. 매트플롯립의 시각적 요소와 기능을 빠르게 표시하는 데 탁월합니다. 하지만 매트플롯립을 처음 사용하는 사용자의 경우 데이터를 시각 자료로 변환하는 과정을 순회하기가 어렵습니다.
실험적 접근 방식의 맥락은 이 장애물에 대한 해결책입니다. 실제 사례를 통해 절차를 작성하여 사용자가 일하는 환경에 대한 이해를 보여줍니다. 이렇게 하면 목표 달성 또는 작업 수행에 대한 기대에 관한 문서와 사용자의 관계가 개선됩니다.
사용자에게 일관된 파생 목적이 있습니다. 예를 들어 신발 회사의 데이터 과학자가 팀에 고객 데이터를 제시하여 시간 경과에 따른 쇼핑 동향을 설명해야 합니다. 이 상황에서 사용자는 매트플롯립을 탐색하는 방법을 배우고 현재 진행 중인 작업을 완료하기 위해 라이브러리 내의 도구를 활용해야 합니다.
문서를 뒷받침하는 추가적인 맥락이 있으면 신규 사용자가 주제를 더 잘 파악할 수 있습니다. 사용자의 파생 목적이 문서화와 유사함 저는 리드 개발자인 Tom Caswell이 2017년 인터뷰에서 "실제로 글을 쓰고 사용자에게 공감을 표하는 사람이 200페이지 분량의 'Introduction to Matplotlib' 도서를 읽고 이를 문서의 주요 항목으로 다루도록 한다.”고 말한 비전을 실현하고자 합니다.
실험적 글쓰기의 대안
이 문서는 매트플롯립의 기능, 즉 사용자가 라이브러리로 할 수 있는 작업을 보여줍니다. 예를 들어, 튜토리얼은 기본 메서드에 대한 설명이 포함되지 않은 패턴을 따르는 경우가 많습니다.
{what the method does} -> {parameters} -> {returns} -> {related links} -> {examples}
프로그래밍 설명서와 지원이 제공되는 경우 사용자가 코드를 직접 실행하여 상황을 파악하는 것이 좋습니다. 프로그래밍 사고방식은 사용자의 주제 이해도를 높이지만 변환을 위한 학습 곡선에는 도움이 되는 콘텐츠가 거의 없습니다. 문서화가 한정되어 있어 부담스러운 과제가 될 수 있습니다.
추가 다이어그램, 이미지 또는 기타 시각 자료를 제공하면 새로운 학습 기회를 창출하는 데 도움이 됩니다. 아래 구조는 새 콘텐츠의 템플릿으로도 사용됩니다. 또한 텍스트가 아닌 이미지 또는 그래픽을 추가하는 경우 콜아웃이나 코치마크와 같은 기능을 사용하면 도움이 될 수 있습니다. 코드가 실행된 출력으로 변환되는 방식이나 위치를 나타내지 않으면 이미지를 탐색하기가 더 어려울 수 있습니다. 주제를 더 잘 이해할 수 있는 강력한 시각적 요소가 결여되어 있다고 생각합니다.
{method explanation} -> {expository use case/scenario} -> {sample code} -> {parameters} -> {returns} -> {additional examples} -> {informational topic/subject affinity links}
문서 작성에 설명 작성을 사용하는 이 대체 접근 방식에는 엄청난 잠재력이 있습니다. 사용자는 변환에 대한 다양한 개념을 보게 되므로 데이터에 시각화를 개발하는 기본 전략을 더 잘 파악할 수 있습니다. 이 지식은 사용자가 혁신하고 현실적인 사용 사례를 기반으로 한 예시에서 제공되는 기능을 활용하는 데 도움이 될 수 있습니다.
매트플롯립이 인기를 얻으면서 사용 편의성과 접근성의 일관성은 도서관의 명성을 증명합니다. 이러한 특성은 코드뿐만 아니라 문서 내에도 드러날 수 있는 패턴과 일반적인 전략을 보여주는 데 적합합니다. 매트플롯립이 직관적이고 표준화된 사용자 프로그래밍 방식인 경우, 리소스 사용이 증가하고 리소스가 확장됨이 분명하다면 기술 문서도 마찬가지일 수 있습니다.
사용자에게 문제가 발생하면 검색을 통해 문제를 해결하는 것이 일반적입니다. 탐색을 기본 방법으로 사용하기보다는 사용자가 문서에서 자체 교육과정을 만들도록 하는 것이 더 효과적일 수 있습니다. 이런 의미에서 사용자는 자신이 겪고 있는 문제에 대한 해결 방법을 검색한 다음 또 다른 문제를 경험하거나 추가 정보를 얻고자 할 때 그 전체에 임베딩된 철저한 링크를 활용하게 됩니다.
여기에는 조직 시스템의 상향식 아키텍처가 포함됩니다. 매트플롯립 내의 모든 주제에 대해, 주제 관심분야와 정보 주제에 대한 풍부한 링크 네트워크가 있으면 강력한 네트워크를 구축하는 데 도움이 될 것입니다. 이 네트워크를 통해 사용자는 주제로 이동하여 해당 주제와 관련된 정보를 점점 더 많이 탐색하면서 문서를 계속 사용할 가능성이 높습니다.
장애물
이처럼 포괄적이고 자세한 프로젝트에는 항상 어려움이 있습니다. 업계의 초보 테크니컬 라이터로서 Sphinx와 ReST를 사용해 문서를 작성한 경험이 제한적입니다. 저는 매트플롯립은 물론 Git에 관해서도 초보자입니다. 이 네 가지 시스템을 다루고 공동작업과 연구에 익숙해지는 데에는 시간이 걸립니다. 커뮤니티 유대감 형성 단계와 그 이전 단계에서 입문 단계에 필요한 토대를 마련하기 위해 시간을 위임해야 합니다. 이 기간 동안 개념과 기본 사항에 문제가 있으면 커뮤니티에 문의하여 추가 지원을 받아야 합니다.
시간대와 온라인 플랫폼을 넘나들며 협업을 조율하는 데도 약간의 조정이 필요할 것입니다. 업계의 사람들이 사용하는 소통의 수단은 다양하므로 모든 매체에서 접근성과 접근성을 높이는 것이 중요합니다. 다양한 기대의 우선순위를 정하는 데 있어 투명하게 할 것입니다. 업계에서 이런 일을 시작한 지 얼마 되지 않았지만, 저는 스스로 책임감을 갖고 피드백과 비판을 받아들이는 데 투자하고 있습니다. 이러한 자질은 어떤 분야에서든 가치가 있다고 생각합니다.
또한 사용성 테스트 향상도 매트플롯립의 진입 경로에 도움이 될 수 있는 문서 섹션입니다. 콘텐츠와 관련된 사용성에 관한 설문조사를 실시하는 목적은 사용자 프로필(예: 캐릭터)을 제공하기 위한 것입니다. 사용자 경험, 업종, 문제 해결 기록과 같은 정보가 중요합니다. 이러한 자료는 시술의 배경이 되는 언어를 형성하는 데 도움이 됩니다. 글쓰기가 각자의 수준에 맞는 경우, 콘텐츠는 정보 전달만을 목적으로 하는 수준을 넘어 더욱 발전하게 됩니다.
큰 어려움은 종종 사용성 테스트의 지속적인 관행을 만드는 데서 발생합니다. 콘텐츠 개발 중에 테스트 인스턴스를 단 한 번만 거치는 경우는 매우 흔합니다. 정기적인 사용성 테스트는 콘텐츠 내러티브를 촉진하는 데 도움이 됩니다. 매트플롯립 커뮤니티에서 일정을 세우거나 사용성 테스트를 반복적으로 진행하고 싶습니다.
결론
여가 시간에는 Python과 Matplotlib를 사용해 본 경험이 약간 있습니다. 최근 몇 개월 동안 제가 독학한 내용은 최신 문서의 지원과 호기심 덕분이었습니다. 그 당시에 제가 제작한 동영상과 멘토도 많았습니다. 저도 관심 있는 프로그래밍 교육과정을 직접 세우기 때문에 아직 배워야 할 것이 많고 개선의 여지가 많습니다.
매트플롯립과 커뮤니티가 GSoD에 대해 갖고 있는 아이디어를 살펴본 결과, 테크니컬 라이터로서의 저의 역량을 개선하고 이면의 사람들로부터 더 많은 것을 배울 수 있는 기회가 생겨나면 좋을 것 같았습니다. 저는 이 매트플롯립 프로젝트가 의미가 있으면서도 제가 이데올로기에서 열정을 가지고 있는 프로젝트라고 생각합니다.
사용 가이드를 개편하면서 테크니컬 라이터로서 제 목표는 사용자가 제공되는 기능에 얽매이지 않고 원하는 작업을 완수할 수 있도록 돕는 것입니다. 최상의 문서화는 지속적으로 성장하고 사용자에 맞게 조정되며 모든 사용자가 자신의 솔루션을 탐색할 수 있게 해 줍니다.