이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- TheGoodDocsProject
- 테크니컬 라이터:
- 비록
- 프로젝트 이름:
- 정보 아키텍처 가이드
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
정보 아키텍처 가이드 계획
이 문서에서는 Good Docs Project를 위한 정보 아키텍처 가이드 계획을 다룹니다. 이 문서는 Google Docs 2020 시즌 제출의 일환으로 준비되었습니다. 이 문서는 제안된 가이드의 사용 사례를 간략하게 설명하고, 계획 수립을 위해 이러한 가이드의 구조에 대한 계획을 스케치합니다.
정보 아키텍처 (IA)는 콘텐츠 구성 방식과 관련이 있습니다. 콘텐츠 자체에 사용되는 스타일이나 단어를 정의하지 않고 콘텐츠의 구조를 다룹니다. 예를 들어 IA 계획은 독자가 누구인지, 콘텐츠에 접근하는 방식, 읽고 있는 환경을 고려합니다. 그런 다음 독자의 요구사항을 가장 잘 충족할 수 있는 적절한 콘텐츠 구조를 고려합니다.
완벽한 환경에서는 비즈니스 목표를 사용하여 문서의 목표를 정의하는 콘텐츠 전략에서 출발하여 문서를 설계합니다. 그런 다음 콘텐츠 전략을 사용하여 문서의 레이아웃과 구조를 정의하는 IA를 만듭니다. 여기에서 도구 모음을 선택하고 콘텐츠를 작성할 수 있습니다. 대부분의 오픈소스 프로젝트의 현실은 콘텐츠 전략이 '사람들이 이 프로젝트를 사용하는 방법을 알 수 있도록 문서를 작성'하는 것만큼이나 단순하지만, 이 간단한 전략만으로도 효과적인 IA를 정의하기에 충분합니다.
이 가이드의 목적은 비전문적인 작성자가 사용해야 하는 템플릿을 결정하기에 충분한 IA를 개발할 수 있는 단순화된 도구를 제공하는 것입니다. 오후에 일반 사람이 완료할 수 있을 만큼 간단해야 하며 교육보다는 행동으로 옮겨져야 합니다. 이상적으로는 개념을 간결하게 소개하고, 독자가 이러한 개념을 자신의 프로젝트와 연관 지어 고려하도록 안내하며, 그 결과를 사용하여 다음 개념으로 넘어갈 수 있습니다.
이 프로젝트를 진행하는 과정에서 독자가 Good Docs 프로젝트를 시작하는 방법을 이해하고 IA 가이드를 효과적으로 사용하여 템플릿 선택을 안내할 수 있도록 프로젝트 README에 대한 일부 업데이트가 필요합니다.
주요 대상
The Good Docs 프로젝트 템플릿을 사용하여 프로젝트 문서를 만들려는 모든 사람
사용 사례: 이 섹션은 독자가 IA 가이드에 접근하는 방법을 살펴보기 위해 작성되었습니다. 이를 통해 독자에게 가장 적합한 서비스를 제공하기 위해 가이드를 어떻게 구성해야 할지 파악할 수 있습니다.
시나리오:
문서가 거의 또는 전혀 없는 오픈소스 프로젝트 또는 제대로 구성 또는 작성되지 않은 문서 제품군을 작업 중인 사용자가 있습니다. The Good Docs Project를 사용해 문서를 정리하기로 결정했지만 무엇부터 시작해야 할지 잘 모릅니다. 학생들은 README를 따라 템플릿을 시작하는 방법을 이해하고, Information Architecture Guide에 따라 콘텐츠 전략을 개발하고 문서 묶음의 디자인을 계획합니다.
제안서
README를 업데이트하여 명확한 첫 단계를 포함해 새로운 독자에게 프로젝트 진행 방법을 더 명확하게 안내합니다. 첫 번째 단계 중 하나는 새로운 IA 가이드의 질문을 읽고 답변하는 것입니다. 이 가이드는 독자가 학문적 의미로 학습/이해하는 데 큰 부담을 주지 않으면서 잠재고객, 콘텐츠 스키마, 사용자/작업 매트릭스 등을 고려하도록 유도합니다. 이 작업이 완료되면 독자는 필요한 템플릿과 이를 가장 효과적으로 완료하는 방법을 파악할 수 있습니다.
조사
이 내용을 연구로 뒷받침하기 위해서는 Abby Covert의 저서 (http://www.howtomakesenseofanymess.com/)를 적극 활용할 것입니다. 이 책은 이미 잘 알고 있고 이미 저술한 많은 콘텐츠의 기반이 되어 사용할 뿐만 아니라, IA를 처음 접하는 사람들이 더 많은 관심을 가지고 읽고 읽을 수 있기 때문입니다. 그런 의미에서 그것은 작은 IA 게이트웨이 약물 같은 것입니다.
초안 ToC
README 파일:
-- Good Docs 프로젝트 소개 |_ 템플릿 사용 대상 |_ 템플릿 작동 방식 |_ 프로젝트에 기여 -- 템플릿 |_ 현재 모든 템플릿 목록 |_ 사용할 템플릿 선택 |_ 시작하기 전에 -- 글쓰기 전에 |_ 누가 문서를 읽을 수 있나요? |_ 문서를 읽는 이유는 무엇인가요? |_ 독자를 위한 글쓰기
IA 가이드:
-- 소개 |_ IA란? |_ 왜 관심을 가져야 할까요? -- 엉망진창 식별 -- 의도 표현하기 -- 현실 얼굴 -- 방향 선택 -- 거리 측정 -- 구조 사용하기 -- 조정 준비