이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- WordPress
- 테크니컬 라이터:
- 암묵적
- 프로젝트 이름:
- 새롭게 업데이트된 전체 문서 스타일 가이드
- 프로젝트 길이:
- 장기 실행 (5개월)
Project description
줄거리:
WordPress는 접근성, 성능, 보안, 사용 편의성을 강조하는 소프트웨어를 통해 전 세계 커뮤니티에 서비스를 제공하기 위해 노력하는 글로벌 비영리 소프트웨어 조직입니다. WordPress의 사명은 웹에서 게시 및 오픈소스 소프트웨어를 민주화하는 것입니다. 디지털 시대에 웹사이트는 문자 그대로 조직/개인의 온라인 가면입니다. WordPress는 인터넷의 35% 를 운영하는 데 기여한 수억 명의 사용자에게 소프트웨어를 효율적으로 제공하는 막대한 작업을 수행합니다. 이러한 사용자에게 더 효율적으로 지원하기 위해 문서는 필수적이며 대부분의 개발자, 관리자, 최종 사용자가 사용합니다. 따라서 문서는 WordPress 생태계의 주요 요소로 자리 잡을 수 있습니다. 현재 WordPress 문서에는 게시를 위한 보편적이고 통합된 규칙 및 스타일 가이드라인이 포함되어 있지 않습니다. 이 제안서의 목적은 WordPress 문서에 보편적으로 적용할 수 있는 완전히 새로운 문서 스타일 가이드라인을 만드는 것입니다. 이 프로젝트의 아이디어는 시맨틱, 문법, 문법 가이드라인, 구두점, 개발자별 규칙, 디자인 속성, 형식 지정 세부정보와 같은 디자인 및 스타일 가이드라인의 모든 측면을 통합하는 것입니다. 또한 어조, 스타일, 시제, 모든 품사, 이름 지정 규칙과 같은 언어 규칙도 통합합니다. 사용되는 도구, 언어, 플랫폼은 WordPress CMS, GitHub, Markdown이며 PHP/MySQL, HTML/CSS, JavaScript로 구성될 수도 있습니다.
프로젝트 계획:
WordPress 문서 스타일 가이드의 현재 상태: WordPress 문서팀은 선언되지는 않았지만 만장일치로 설정된 게시 방법론을 구현해 왔습니다. 하지만 가끔은 어떤 요소가 추측에 의지해 그 과정이 추측으로 바뀌는 경우가 있습니다. WordPress용 도움말을 작성하고 게시하기 위한 고정된 표준과 기준은 없습니다. 문서팀은 프로젝트별 스타일 가이드라인을 작성했지만 보편적으로 적용할 수 있는 가이드라인은 없습니다. 기존의 대부분의 스타일 가이드라인은 하나의 핸드북에 통합되어 있지 않거나 지원 중단되어 업데이트가 필요합니다. 따라서 WordPress 문서를 표준화하기 위해 통합 스타일 가이드를 설계하고 개발해야 합니다.
목표:
인터넷 웹사이트의 35% 이상이 WordPress에서 실행되며, 이는 수백만 명의 개발자와 최종 사용자가 WordPress의 인상적인 기능을 활용하고 있음을 나타냅니다. 문서는 이러한 개발자와 사용자가 불편을 겪더라도 번거롭지 않게 이러한 기능을 효율적으로 수행할 수 있도록 지원하는 데 필수적인 요소입니다. 이 프로젝트 제안서의 전반적인 목표는 디자인 및 스타일 가이드를 표준화하고, 기존 스타일 가이드를 통합하고, 업데이트하고, WordPress 문서에 대한 새로운 규정 및 사양을 추가하는 것입니다. 이렇게 하면 WordPress 문서에서 사용 편의성, 단순성, 일관성을 높일 수 있습니다.
구현:
이 프로젝트의 멘토 (존 앙)가 제안한 대로 프로젝트는 탐색, 정의, 구현, 유지보수의 4단계로 접근할 수 있습니다. 프로젝트가 시작되기 전 인턴십 전 기간에 멘토와 협력하여 후속 일정 및 결과물에 따라 적절한 일정과 타임라인을 최종적으로 결정할 것입니다. 이 프로젝트의 WordPress 시스템과 작업 프로토콜을 자세히 알아보겠습니다.
인턴십이 시작되면 멘토와 계획의 개요를 논의하고 초안을 작성할 예정입니다. 요구사항과 필요성이 결정됩니다. 먼저 문서 흐름과 사용자 상호작용 프로세스를 간략히 설명하겠습니다. 그런 다음 각 섹션, 카테고리, 구성요소의 레이아웃 와이어프레임이 간략하게 설명됩니다. 그런 다음 멘토가 이 레이아웃을 검토합니다. 필요한 경우 레이아웃이 다시 디자인되고 일부 구성요소가 추가/삭제됩니다. 그런 다음 인터페이스 흐름의 사용성과 실행 가능성을 판단하기 위한 사용자 조사를 진행할 예정입니다. 이후 문서 스타일 가이드가 섹션별로 구현됩니다 (아래 다이어그램 참고). 오픈소스 또는 크리에이티브 커먼즈 라이선스를 보유한 다른 조직의 스타일 가이드를 참고하여 가이드를 추가할 수도 있습니다. 이 기간 동안 사용성 문제가 발생하면 다시 디자인하겠습니다.
스타일 가이드를 완료하고 HelpHub와 통합한 후 테스트와 최적화가 진행됩니다. 취약점, 중복 요소 또는 구성요소가 수정됩니다. UI 및 코드 테스트가 실행되고 필요한 경우 원치 않는 버그 및 오류가 수정됩니다. 언어, 문법, 맞춤법, 구두점 등 전체 스타일 가이드에 대한 최종 품질 관리가 진행됩니다.
예상치 못한 지연으로 인해 대기 중인 작업은 버퍼 기간에 완료됩니다. 프로젝트 진행 과정에서 실행 가능으로 판단되는 추가 기능은 최종 테스트가 완료된 후에 구현할 수 있습니다. 배포 계획이 수립되고 완성된 제품이 제출됩니다.
도구 및 방법론:
문서는 Google Docs와 같은 공동작업 플랫폼에서 컴파일되고 편집됩니다. GitHub를 통해 게시해야 하는 경우 Markdown 또는 GitHub 맞춤형 마크다운과 같은 마크업 언어도 구현할 수 있습니다. 디자인 및 스타일 표준의 경우 오픈소스 스타일 가이드라인을 참고할 수도 있습니다. 마지막으로 완성된 문서는 WordPress를 사용하여 형식이 지정되고 게시됩니다.
구성요소 표:
다음은 스타일 가이드에서 구현할 수 있는 구성요소의 전체 목록입니다. 문서 가이드라인 - 접근성, 문서 구조, 인코딩, 외부 출처, 사실, 서체, 전 세계 시청자, 포용성, 적법성, 멀티플랫폼 접근성, 모호하지 않음, 과도한 주장 금지, 페이지 레이아웃, 정치적 올바름, 프로토콜, 보안, 문장 구조, 간결한 문장, 어조 및 스타일, 편견 없음
언어 및 문법 - 약어 및 축약어, 긍정 및 부정, 관사, 대문자, 절, 직접/간접 인용, 1인칭/2인칭/3인칭, 성별, 용어집, 명사, 접두사 및 접미사, 전치사, 호칭, 참조, 속어 및 전문 용어, 맞춤법, 전문 용어, 시제, 동사, 태
구두점 - 아포스트로피 및 인용 부호, 콜론 및 세미 콜론, 쉼표, 생략 부호, 느낌표, 하이픈 및 대시, 괄호, 마침표, 물음표, 슬래시
형식
사용자 인터페이스 - 활동, 버튼, 코드 스니펫, 코드 블록, 명령줄 인터페이스, 대화상자, 메뉴 및 드롭다운, 팝업 및 알림, 탭, 용어, UI 요소, Windows
코드 - CSS, HTML, JS, 마크다운, MySQL, PHP, 구문, XML
단어 사용 사전/용어집 - A~Z