Markdown 테스트 사양을 관리하고 싶습니다!

바쁜 분들에게

아마도 대부분의 소프트웨어 사양은 Excel에서 관리하는 경우가 많을 것입니다. 하지만 버전 관리와 차이가 GitHub에 비해 괜찮다고 생각했습니다.

이러한 문제를 해결하기 위해 우선 (개인적으로) 다루기 쉬운 테스트 사양서를 Markdown+GitHub로 관리하려고 시도했습니다. 버전 관리와 차등 관리는 확실히 쉬워졌습니다. 드디어 목록에서 보거나 집계하고 싶을 때 변환하는 파이썬 스크립트도 만들었습니다.

변환 소스 코드는 GitHub 으로 공개하고 있습니다.

불필요한 Excel을 박멸하고 싶습니다.

아직 소프트웨어 사양에 Excel을 관리하는 경우가 많다고 생각합니다. 이 엑셀 관리에 싫증이 났다.

바이너리 데이터 때문에 GitHub 등의 버전 관리 툴과의 궁합이 나쁘다. "〇〇_최종판.xlsx", "〇〇_최종판_new.xlsx", "〇〇_최종판(이것을 사용).xlsx"와 같은 파일이 같은 디렉토리에 있다고 대답할 것 됩니다.

누가 언제 어떻게 편집했는지, 라고 하는 차분 관리도 이마이치.

파일이 커지면 오픈이나 저장에도 이상하게 시간이 걸린다.

원래 사양서가 어디에 있는지, 누군가에게 물어 보지 않으면 모른다

등, 들으면 기리가 없습니다. 소스 코드는 GitHub로 관리하고 있기 때문에, 같은 장소·같은 툴로 사양서를 통일 관리하고 싶다는 생각이 강해져 갔습니다.

그렇다고 해도 갑자기 전부를 대체하는 것은 어렵기 때문에, 우선은 개인적으로 임하기 쉬웠던 테스트 사양서 Excel의 박멸에 임했습니다.

Markdown+GitHub로 테스트 사양 관리

Markdown+GitHub이라면 위의 고민을 거의 해결해 주었습니다만, Markdown는 텍스트 베이스이기 때문에, 일람표시를 할 수 없거나, 집계 작업은 할 수 없었습니다. 그래서 Markdown 유형 테스트 사양을 Excel로 변환하는 파이썬 스크립트를 만들었습니다. 소스 코드는 GitHub 으로 공개하고 있습니다.

실제로 사용해보십시오.

실제 프로젝트에서 운용해 보고, 좋은 점도 있으면 과제도 보아 왔습니다.

좋은 점

소스 코드와 같은 디렉토리 계층에서 사양서를 관리할 수 있기 때문에, 사양서를 찾는 수고가 없었다.

사양서내까지 일괄 검색·치환을 할 수 있게 되었다(Excel은 열 때까지 내용을 몰랐다).

버전 관리와 차등 관리가 매우 편안합니다.

오픈에도 거의 시간이 걸리지 않아 생산성이 향상되었다.

IDE만으로 작업이 완결되게 되었다. IDE/에디터와 Excel의 망설임 작업이 없어졌다.

도전

그림 표현이 약하다. 테스트 결과 스크린샷을 붙여넣을 수 없습니다.

집계 작업을 할 수 없다. 여기는 과연 Excel에 군배.

사이고에게

Markdown에 의한 사양서 관리는 아직 발전 도상이지만, 솔직히 기존의 Excel 관리보다는 혜택이 크다고 느꼈습니다. 구식의 방법을 일신하는 것은 꽤 뼈가 부러지지만, 가능한 범위에서 계속해 나가려고 생각했습니다. 다음은 더 다른 사양서에서.

참고문헌

Excel 디자인을 Markdown으로 만들었습니다.

토리 사와 / 안녕 rt. py