워크플로

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

Technical Writing 팀은 다음 사항에서 기여자, 개발자, 제품 관리자와 협업하기 위해 워크플로를 사용합니다. 제품 문서 변경 UI 텍스트 릴리스 포스트 제품 변경에 대한 문서 # GitLab 제품 문서를 작성하고 유지 관리하는 절차는 해당 문서가 다음 중 어느 쪽인지에 따라 달라집니다. 새 기능 또는 기능 개선: 특정 마일스톤에 맞춰 제공되며 특정 코드 변경과 연관됩니다. 이 문서가 가장 높은 우선순위를 가집니다. 특정 마일스톤 외부의 변경 : 일반적으로 특정 코드 변경과 연관되지 않고, 우선순위가 낮으며 모든 GitLab 기여자에게 열려 있습니다. 마일스톤에 문서가 필요한 경우는 다음과 같습니다. 사용자 또는 관리자 경험에 영향을 주는 새 기능이나 개선된 기능이 출시되는 경우. 사용자 인터페이스 또는 API에 변경이 있는 경우. 프로세스, 워크플로 또는 이전에 문서화된 기능이 변경되는 경우. 기능이 사용 중단되거나 제거되는 경우. 백엔드 기능이 추가되거나 변경되는 경우에는 일반적으로 문서가 필요하지 않습니다. 개발자 책임 # 개발자는 기능 또는 기능 개선에 대한 문서의 주 작성자입니다. 개발자는 다음 사항을 책임집니다. 기능에 필요한 초기 콘텐츠를 개발합니다. 어떤 문서를 언제 제공해야 하는지 파악하기 위해 제품 관리자와 협의합니다. 같은 그룹의 다른 개발자에게 기술 검토를 요청합니다. 새 기능 또는 기능 개선을 제공하는 DevOps stage 그룹에 배정된 Technical Writer 에게 문서 검토를 요청합니다. 가능하면 코드가 포함된 머지 리퀘스트에 문서를 함께 포함해야 합니다. 자세한 내용은 가이드라인 을 참고합니다. 이 MR의 작성자, 즉 프론트엔드 또는 백엔드 개발자가 문서를 작성해야 합니다. Note 커뮤니티 기여자는 GitLab 팀 멤버에게 추가 도움을 요청할 수 있습니다. 작성 # 문서는 제품의 필수 구성 요소이므로, ~"type::feature" 이슈에 ~documentation 레이블이 함께 붙어 있으면 새로 작성하거나 업데이트한 문서를 기능 코드와 함께 출시해야 합니다. Technical Writer는 이슈 단위로 요청하고 계획한 대로 기꺼이 지원합니다. 문서가 필요한 기능 이슈에서는 제품 관리자와 Technical Writer가 달리 합의하지 않은 한 다음 절차를 따릅니다. 새로 작성하거나 편집한 문서를 다음 중 한 곳에 포함합니다. 코드를 도입하는 머지 리퀘스트. 같은 시기에 올리는 별도의 머지 리퀘스트. 제품 관리자가 이슈에서 작성한 문서 요구 사항 을 사용하고, 필요에 따라 추가 문서 계획이나 아이디어를 논의합니다. 새로 작성하거나 변경한 문서에 폭넓은 협업이나 논의가 필요하면, 계획 과정에 연결된 별도 이슈를 사용할 수 있습니다. 문서 가이드라인 과 거기에 연결된 다음 자료를 활용합니다. 문서 폴더 구조 . 문서 스타일 가이드 . Markdown 가이드 . 다음과 같은 경우에는 이슈나 머지 리퀘스트 또는 #docs Slack 채널에서 해당 DevOps stage 담당 Technical Wri