README TXT 파일 작성 방법: 경험이 있는 사람이 알려주는 간단한 가이드

솔직히 말해서, 잘 구성된 README TXT를 만드는 건 좀 지루하고 따분해 보일 수 있지만, 데이터셋이나 프로젝트를 다른 사람들과 실제로 공유할 계획이라면 정말 중요합니다.저도 원시 데이터만 있고, 설명도 없고, 뭐가 뭔지 전혀 모르는 상황에 처한 적이 있는데, 나중에 정말 혼란스러울 뿐입니다.그래서, 괜찮은 README 파일을 만드는 간단한 방법을 소개합니다.거창한 내용은 아니고, 다른 사람(혹은 미래의 당신)이 이 내용이 무엇인지 이해할 수 있을 만큼만 필요한 정보만 담았습니다.

텍스트 편집기 열기: 전체 시작하기

우선, 자신에게 편한 일반 텍스트 편집기를 사용하세요. Windows에서는 메모장이 작동하지만, 좀 더 능숙하다면 Notepad++를 사용하거나 Mac에서는 일반 텍스트 모드의 TextEdit을 사용하는 것이 더 간편합니다. Linux에서는 gedit, nano 또는 배포판에 있는 다른 프로그램을 사용하면 됩니다.솔직히 말해서, 저도 vim을 써 봤는데, 처음 시작하는 사람에게는 좀 과한 기능입니다.어쨌든 열어 보세요.여기서 하는 일은 기본적인 정보를 쓰는 것뿐입니다.서식이나 서식 있는 텍스트는 필요 없습니다.그냥 일반 텍스트입니다.README.txt다른 이름으로 저장하세요.어디에 속하는지 명확하게 하세요.프로젝트 전용 폴더가 있다면 README 파일과 데이터 파일을 바로 그 폴더에 저장하세요.파일 > 다른 이름으로 저장을 사용하고 일반 텍스트(*.txt)를 선택하세요.간단합니다.

README 이름 지정: 무엇이라고 불러야 할까?

맨 위에 데이터 세트나 프로젝트 이름을 적어주세요.이건 단순한 자리 표시자가 아니라 모든 것을 명확하게 보여주는 중요한 요소입니다.예를 들어, “README”처럼 이름을 붙이는 대신 “README”처럼 구체적으로 적어주세요.Climate_Data_2024.txt이렇게 하면 나중에 폴더를 스크롤할 때 무엇이 ​​무엇인지 헷갈리지 않습니다.사소한 것처럼 보일 수 있지만, 엄청난 시간을 절약할 수 있습니다.날씨 데이터가 필요할 때 마구잡이로 꺼내 쓰지 않도록 도구 상자에 라벨을 붙이는 것과 같다고 생각하면 됩니다.

이것을 만든 사람과 DOI 링크 나열

이제 저자 또는 팀 목록을 포함합니다.솔로 프로젝트인 경우 이름만 포함할 수 있습니다.DOI (디지털 개체 식별자, 데이터 또는 출판물에 대한 영구 링크와 유사)가 있는 경우 추가합니다.일반적으로 Zenodo, DataCite 또는 GitHub와 같은 저장소에서 얻을 수 있습니다.예: https://doi.org/xx/xxxxx. DOI를 포함하면 데이터 세트를 인용하기 쉽고 신뢰성이 더해지며, 특히 다른 사람이 재사용할 경우 더욱 그렇습니다.사용해야 할지 확신이 서지 않으면 “나중에 누가 이것을 검증하거나 인용하고 싶어 할까?”라고 생각해 보세요.그렇다면 DOI를 추가하세요.모범 사례는 간단하지만 완전하게 유지하는 것입니다.누가 이것을 만들었거나 어디에서 왔는지 추측하고 싶어하는 사람은 없습니다.

생성 및 마지막 업데이트 날짜 추가

그 후, README를 만든 날짜와 마지막으로 업데이트한 날짜를 기록해 두세요.2024-04-25 처럼 수동으로 날짜를 입력할 수도 있고, 더 멋지게 만들고 싶다면 명령줄 도구를 사용하여 생성할 수도 있습니다.예를 들어, Mac/Linux에서는 명령 date을, Windows PowerShell에서는.Get-Date하지만 솔직히 그냥 입력해도 괜찮습니다.이 정보는 특히 시간이 지남에 따라 데이터 세트나 문서를 업데이트하는 경우 정말 유용합니다.사람들이 최신 정보를 보고 있다는 것을 알 수 있도록 관련 파일의 새 버전이 있는 경우에도 언급하는 것이 좋습니다.데이터 세트가 정기적으로 업데이트되는 경우 v1.0 과 같은 버전 번호 나 “마지막 업데이트” 메모를 추가하여 명확하게 유지하는 것이 좋습니다.화려하지는 않지만 나중에 혼란을 피하는 데 도움이 됩니다.

변수, 용어 또는 데이터 열 문서화

여기서 마침내 좀 더 자세히 설명할 수 있게 되었습니다.데이터의 모든 변수, 기능 또는 주요 용어를 나열하세요.매우 자세하게 설명하세요.예를 들어, 데이터 세트가 온도를 기록하는 경우 섭씨인지 화씨인지 온도(°C) 처럼 지정하세요.기압, 습도, pH 수준 등 다른 측정값에도 동일하게 적용됩니다.용어의 의미나 사용되는 단위가 확실하지 않으면 pH 수준 [?] 처럼 물음표를 표시하세요.그러면 이후 사용자나 본인도 나중에 다시 확인해야 한다는 것을 알 수 있습니다.또한 데이터에서 특정 좌표계나 참조 프레임(예: 지리 데이터의 경우 WGS84)을 사용하는 경우 해당 정보를 추가하세요.각 변수에 대한 간단한 예를 포함하면 어떤 종류의 값을 예상해야 하는지 명확하게 알 수 있어 보너스 포인트가 됩니다.

---

결론적으로, 이런 느슨한 템플릿을 따르면 README는 단순한 빈 페이지가 아닙니다.누구나 (솔직히 말해서, 미래의 당신도 포함해서요) 안에 무엇이 들어 있고 어떻게 구성되었는지 이해할 수 있는 간단한 로드맵과 같습니다.솔직히 말해서, 얼마나 많은 세부 정보를 추가해야 할지, 마지막 업데이트 날짜를 어디에 넣어야 할지, 너무 많은 내용을 담지 않고 어떻게 해야 할지 알아내는 데 몇 번이나 시도해야 했습니다.하지만 간단한 일반 텍스트 파일이라도 이것저것 만져보는 게 모든 것을 문서화하지 않고 내버려 두는 것보다는 낫습니다.정말입니다.

도움이 되었으면 좋겠네요.모든 걸 파악하는 데 너무 오래 걸렸거든요.행운을 빌고, 즐겁게 문서화하세요! 적어도 몇 주 동안 무시했던 모호한 “README”보다는 나을 거예요.

---

---