용어집 및 작성 지침(메타 문서)
이 문서는 사이트에 표시하기 위한 것이 아닌 내부 작성 지침 문서예요. Backstage 도입 가이드 시리즈를 집필하거나 기여할 때 참고하는 자료예요.
출처: 문서
본문
용어집
- 페이지(Pages): 단일
md파일. - 가이드(Guides): 같은 폴더 아래에 묶인 여러 페이지.
전반적인 작성 지침
이 문서들의 목표는 기술 챔피언과 비기술 사용자가 Backstage 도입 여정에서 무엇을 기대해야 하는지 알 수 있도록 하는 포괄적인 가이드 세트를 제공하는 거예요. 여기에는 Backstage의 영향을 정량화하는 방법, 그 결과를 리더십에게 발표하는 방법, 회사에 맞는 올바른 것에 집중하는 방법, 개발자와 소통하기 위한 팁과 요령 등 여러 리소스가 포함돼요.
가이드 페이지를 쓸 때는 가볍게 쓰세요! 지시형 문서이면서 동시에 대화체처럼 읽기 즐거운 문서여야 해요. 가이드는 서로 이어져야 해요. 진행 단계를 따라 읽다 보면 독자가 단계를 넘어가며 개념에 더 편안하고 자신감을 느끼게 돼요. 각 가이드는 독립적으로도 성립하되 서로 링크를 걸 수 있어야 해요.
섹션
사용자는 문서의 요약 섹션, "What is Backstage", "The Spotify story" 등을 이미 읽었어야 해요.
시작하기
데모 사이트를 둘러보며 Backstage가 무엇을 제공할 수 있는지 감을 잡는 걸 추천해요. 기술적인 분이거나 기술적인 분과 함께 일하고 있다면 golden-path/create-app과 golden-path/deploying-backstage 의 단계를 따라 회사만을 위한 무언가를 실행해 볼 수 있어요.
리더십 동의 얻기
첫 번째 이해관계자 피드백
Backstage가 회사에 잘 맞는다고 생각한다면, 같은 생각을 하거나 하게 될 다른 사람들이 있을 가능성이 커요. 이미 그들을 식별했을 수도 있죠. 이 첫 피드백 라운드에서는 그 그룹이 어떤 구성이어야 하는지, 기술/비기술 멤버의 요구 수가 있는지, 이 시점에 리더십이 개입돼야 하는지 등에 대한 권장 사항을 공유하세요.
비기술 사용자에게는 고유한 인스턴스를 구축하는 데 도움을 줄 기술 파트너를 찾는 걸 권장해요.
인스턴스 커스터마이징
이 시점에서는 golden-path/create-app과 golden-path/deploying-backstage 를 통해 이미 인스턴스를 만들었다고 가정해요. 이제 회사의 필요에 맞게 커스터마이징을 시작해야 해요. 작게 시작하고, catalog-info YAML 파일 몇 개를 작성해 개인화된 카탈로그를 만들기 시작하세요.