Readme's - 단순한 기술 지침 그 이상

대부분의 개발자에게 Readme 파일은 액세스하는 첫 번째 리소스입니다. 여기에는 프로젝트 설정 방법에 대한 정보, 지침 및 더 많은 정보가 포함되어 있습니다. 예를 들어 소프트웨어 버전이 베타 버전이거나 안정적인 경우 프로젝트 팀이 사용하는 git 워크플로, 실행 중인 라이선스 등.

그러나 모든 기술적인 것 외에도 더 많은 정보를 입력하는 것을 고려해야 합니다.

읽어보기를 시작하는 방법



프로젝트, 회사 또는 팀 주장과 같은 긍정적인 것으로 시작하십시오. 당신이 하나의 팀이고 함께 일하고 있다는 것을 팀에 보여주는 것.

We are one team - with no alpha leaders and no beta teams


연락처 목록



누가 연락 담당자인지 또는 어떤 주제에 대해 책임이 있는지 아는 것이 중요합니다. 프로젝트 리더는 누구입니까? 리드 개발자가 있습니까? 다른 팀, 제3자, 다른 분야 등과의 접촉이 필요하십니까? Readme에 넣거나 최소한 문서화된 플랫폼에 링크하십시오.

## Team - Contact Persons
You can find a full list of the team at 
[confluence](https://linktoteamcontactpage)


인간답게 - 언제나



어떻게 팀으로 일하고 싶습니까? 당신에게 중요한 것은 무엇입니까? 최근 프로젝트에서 readme 파일을 설정했고 팀으로서 집중해야 할 사항에 대한 명확한 그림을 제공하는 것이 중요했습니다. 구축해야 하는 애플리케이션을 만들 시간이 많지 않았습니다. 이상적인 세상에서 나는 팀과 함께 그것들을 정의할 것입니다.

## Be Human - User. First. Always.
* We work for the best overall result and 
  act in the interests of the whole.
* We trust each other and are open 
  to new input / opportunities.
* We treat each other with respect, 
  empathy and believe that everyone is acting as their best.
* We make each other successful and give a hand if needed.
* We keep it simple.


문서의 끝에 "우리는 어떻게 일하고 싶습니까?"라는 진술을 넣지 마십시오. 중요하며 상단에 있어야 합니다.

읽어보기를 종료하는 방법



클레임/메시지로 추가 정보를 닫습니다. 나는 다른 용어에서 처음부터 무언가를 사용하기로 선택했습니다.

> Together we can make a change. Together we can do it. 
  As one team with no alpha leaders - no beta teams 💖 🤓 ❤️ 💻


우리는 COVID19와 싸우는 데 도움이 되는 애플리케이션을 구축했습니다. 제 시간에 맞춰 진행되고 진행 중인 팬데믹에 대응하기 위해 초과 근무를 많이 해야 한다는 것이 매우 분명했습니다. 그래서 Readme의 다음 부분이 저에게 가장 중요한 부분이었습니다. 어떤 프로젝트도 모든 팀원의 건강이나 (가족)보다 더 중요하지 않다는 것을 분명히 하고 싶었습니다. 나를 기쁘게 한 것은 팀이 Readme의 해당 부분을 자주 인용하고 서로를 돌보는 것입니다. '당신의 기술 책임자가 처음에 이것을 제자리에 두었습니다. 병가를 부르거나 휴식을 취하는 것을 두려워하지 마십시오.' 저는 그 사실이 매우 기쁘고 팀이 자랑스럽습니다.

## !important 🚨

Please remember that your (mental) health 
(and of your family) comes first. 
If you are facing a health problem, 
no matter at which point of the project, 
please inform at least one person 
of the team and take a break!



그렇기 때문에 특히 당신이 기술 리드/리드 개발자인 경우 Readme 파일에 약간의 개성을 추가하는 것이 좋습니다. .

루트 수준에서 프로젝트 Readme 파일에 무엇을 입력하고 있습니까?

좋은 웹페이지 즐겨찾기