이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- TheGoodDocsProject
- 기술 문서 작성자:
- 과도한 말
- 프로젝트 이름:
- 정보 아키텍처 가이드
- 프로젝트 길이:
- 표준 기간 (3개월)
Project description
정보 아키텍처 가이드 계획
이 문서에서는 Good Docs 프로젝트의 정보 아키텍처 가이드 계획을 다룹니다. 이 문서는 Google Season of Docs 2020 제출의 일환으로 준비되었습니다. 제안된 가이드의 사용 사례를 간략히 설명하고 계획 목적으로 가이드 구조의 계획을 스케치합니다.
정보 아키텍처 (IA)는 콘텐츠 구성 방식과 관련이 있습니다. 콘텐츠 자체에서 사용되는 스타일이나 단어를 정의하지 않고 콘텐츠의 구조를 다룹니다. 예를 들어 IA 계획에서는 독자가 누구인지, 콘텐츠에 접근하는 방식, 독자가 콘텐츠를 읽는 환경을 고려합니다. 그런 다음 이러한 독자 요구사항에 가장 적합한 콘텐츠 구조를 고려합니다.
완벽한 환경에서 비즈니스 목표를 사용하여 문서의 목표를 정의하는 콘텐츠 전략으로 시작하여 문서를 설계합니다. 그런 다음 콘텐츠 전략을 사용하여 문서의 레이아웃과 구조를 정의하는 IA를 만듭니다. 여기에서 도구 모음을 선택하고 콘텐츠를 작성할 수 있습니다. 대부분의 오픈소스 프로젝트에서 콘텐츠 전략은 '사람들이 이 프로젝트를 사용하는 방법을 알 수 있도록 문서를 작성'하는 것처럼 간단하지만, 이처럼 간단한 전략으로도 효과적인 IA를 정의할 수 있습니다.
이 가이드의 목적은 전문 작가가 아닌 작성자가 사용할 템플릿을 결정하는 데 충분한 IA를 개발할 수 있는 간소화된 도구를 제공하는 것입니다. 평범한 사람이 오후에 완료할 수 있을 정도로 간단해야 하고 교육보다는 행동을 우선시해야 합니다. 개념을 간결하게 소개하고 독자가 자신의 프로젝트와 관련하여 이러한 개념을 고려하도록 안내하고 그 결과를 사용하여 다음 개념으로 넘어가는 것이 좋습니다.
이 프로젝트의 스캐폴딩으로서, 독자가 Good Docs 프로젝트를 시작하는 방법을 이해하고 IA 가이드를 효과적으로 사용하여 템플릿을 선택할 수 있도록 프로젝트 리드미를 일부 업데이트해야 합니다.
주요 시청자층
The Good Docs Project 템플릿을 사용하여 프로젝트 문서를 작성하려는 모든 사용자
사용 사례: 이 섹션에서는 독자가 IA 가이드에 접근하는 방식을 살펴봅니다. 이렇게 하면 독자에게 최고의 서비스를 제공하기 위해 가이드가 어떻게 구성되어야 하는지 파악하는 데 도움이 됩니다.
시나리오: 문서가 거의 없거나 없는 오픈소스 프로젝트 또는 구성이나 작성이 잘못된 문서 모음을 사용해 작업하는 사용자가 있습니다. 'Good Docs Project'를 사용해 문서를 정리하기로 했지만 어디서부터 시작해야 할지 잘 모릅니다. README에 따라 템플릿을 시작하는 방법을 알아보고 Information Architecture Guide에 따라 콘텐츠 전략을 수립하고 문서 모음의 모양을 계획합니다.
제안서
명확한 첫 단계를 포함하여 신규 독자가 프로젝트를 더 명확하게 이해할 수 있도록 리드미를 업데이트합니다. 첫 번째 단계 중 하나는 새로운 IA 가이드의 질문을 읽고 답하는 것입니다. 이 가이드는 독자가 학문적 관점에서 무엇을 배우고 이해하는 데 큰 부담을 주지 않고 잠재고객, 콘텐츠 스키마, 사용자/작업 매트릭스 등을 고려하도록 유도합니다. 이 작업이 완료되면 독자는 필요한 템플릿과 이를 가장 잘 작성하는 방법을 이해하게 됩니다.
조사
이를 연구로 뒷받침하기 위해 Abby Covert의 책 (http://www.howtomakesenseofanymess.com/)을 많이 참고합니다. 이 책을 잘 알고 있으며 이미 작성하고 앞으로 사용할 많은 콘텐츠의 기반이 되었기 때문이기도 하지만, IA에 관심이 있는 초보자가 쉽게 읽을 수 있기 때문이기도 합니다. 그런 점에서 IA의 관문 약물이라고 할 수 있습니다.
목차 초안
README 파일:
-- 좋은 문서 프로젝트 소개 |_ 템플릿을 사용해야 하는 사용자 |_ 템플릿 작동 방식 |_ 프로젝트에 참여하기 -- 템플릿 |_ 현재 사용 가능한 모든 템플릿 목록 |_ 사용할 템플릿 선택하기 |_ 시작하기 전에 -- 작성하기 전에 |_ 문서를 읽는 사용자는 누구인가요? |_ 왜 문서를 읽는 것일까요? |_ 독자를 위한 글쓰기
IA 가이드:
-- 소개 |_ IA란 무엇인가요? |_ 왜 중요한가요? -- 상황 파악하기 -- 의도를 기술하세요 -- 현실을 마주하세요 -- 방향 선택 -- 거리 측정 -- 구조 맞추기 -- 조정 준비