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