워크플로

Technical Writing 팀이 기여자, 개발자, 제품 관리자와 협업하는 문서 작성·검토·릴리즈 포스트 워크플로를 설명합니다.

Technical Writing 팀은 다음 작업에서 기여자, 개발자, 제품 관리자와 협업하기 위해 워크플로를 사용합니다: 제품 문서 변경 UI 텍스트 릴리즈 포스트 제품 변경을 위한 문서 # GitLab 제품 문서를 생성하고 유지 관리하는 프로세스는 문서의 종류에 따라 다릅니다: 새로운 기능 또는 기능 개선: 특정 마일스톤에 맞춰 제공되며 특정 코드 변경과 연관됩니다. 이 문서는 최우선 순위를 가집니다. 특정 마일스톤 외부의 변경 : 일반적으로 특정 코드 변경과 관련이 없으며, 우선순위가 낮고 모든 GitLab 기여자에게 열려 있습니다. 다음 경우에 마일스톤에 대한 문서가 필요합니다 : 사용자 또는 관리자 경험에 영향을 미치는 새로운 기능 또는 향상된 기능이 릴리즈될 때. 사용자 인터페이스 또는 API에 변경이 있을 때. 프로세스, 워크플로 또는 이전에 문서화된 기능이 변경될 때. 기능이 사용 중단(deprecated)되거나 제거될 때. 백엔드 기능 이 추가되거나 변경될 때는 일반적으로 문서가 필요하지 않습니다. 개발자 책임 # 개발자는 기능 또는 기능 개선에 대한 문서의 주요 작성자입니다. 개발자는 다음에 대한 책임이 있습니다: 기능에 필요한 초기 콘텐츠 개발. 어떤 문서를 언제 제공해야 하는지 이해하기 위해 제품 관리자와 협력. 해당 그룹의 다른 개발자에게 기술 검토 요청. 새로운 기능 또는 기능 개선을 제공하는 DevOps Stage 그룹에 배정된 Technical Writer 에게 문서 검토 요청. 가능하면 코드가 포함된 머지 리퀘스트에 문서도 함께 포함해야 합니다. 자세한 내용은 가이드라인 을 참조하세요. 이 MR의 작성자(프론트엔드 또는 백엔드 개발자)가 문서를 작성해야 합니다. 커뮤니티 기여자는 GitLab 팀 멤버에게 추가적인 도움을 요청할 수 있습니다. 작성 # 문서는 제품의 필수적인 부분이므로, ~"type::feature" 이슈에 ~documentation 라벨도 포함되어 있다면 기능의 코드와 함께 새로운 또는 업데이트된 문서를 제공해야 합니다. Technical Writer는 이슈별로 요청 및 계획에 따라 기꺼이 도움을 드립니다. 문서가 필요한 기능 이슈의 경우, 제품 관리자 및 Technical Writer와 달리 합의하지 않는 한 아래 프로세스를 따르세요: 다음 중 하나에 새로운 및 편집된 문서를 포함하세요: 코드를 도입하는 머지 리퀘스트. 거의 동시에 제출된 별도의 머지 리퀘스트. 이슈에서 제품 관리자가 개발한 문서 요구사항 을 사용하고 필요에 따라 추가 문서 계획이나 아이디어를 논의하세요. 새로운 또는 변경된 문서가 광범위한 협업이나 대화가 필요한 경우, 계획 프로세스를 위해 별도의 연결된 이슈를 사용할 수 있습니다. 문서 가이드라인 과 여기에 연결된 다른 리소스를 사용하세요: 문서 폴더 구조 . 문서 스타일 가이드 . 마크다운 가이드 . 다음의 경우 이슈 또는 머지 리퀘스트, 또는 #docs Slack 채널에서 관련 DevOps Stage 의 Technical Writer에게 연락하세요: 문서를 위한 올바른