개발 도구·micro-SaaS Stack Exchange · 2024-03-01

기술 문서를 Git으로 관리하고 싶지만 .docx diff가 안 된다

Using Git for technical docs? Diff is useless for .docx

30초 요약

누가Stack Exchange · 2024-03-01 · 추천 1 · 댓글 2
무엇을 원하는가기술 문서를 Git으로 관리하고 싶지만 .docx diff가 안 된다
무엇을 만들 수 있나A smart Word↔Markdown converter with semantic diff rendering as a CI bot showing doc changes in PRs.

원글 발언

“The team wants Git for product docs. Markdown is fine, but contracts/specs are Word files — binary diffs and merges are terrible.”
— Stack Exchange · 2024-03-01 · softwarerecs.stackexchange.com/questions/89985/is-it…

배경과 문제

아픈 지점

문서 엔지니어링은 실제 트렌드지만 Word와 Git 사이에 쓸 만한 계층이 없습니다.

제품 방향

무엇을 만들 수 있나

A smart Word↔Markdown converter with semantic diff rendering as a CI bot showing doc changes in PRs.

검증 방법

원글의 댓글을 끝까지 읽고 반복되는 구체적 상황을 적어 두세요. 반복이 곧 수요의 밀도입니다.
"docs / git" 관련 기존 도구를 검색해 어느 한 단계만 커버하는지 확인합니다.
한 줄 랜딩 페이지를 만들어 Stack Exchange에 공유하고 가격을 묻는 사람이 나타나는지 봅니다.

기존 대안

PandocSharePoint

스레드의 목소리 · 인기 댓글

인기 댓글은 기계 번역입니다. 원문은 원본 스레드에서 확인할 수 있습니다.

You can use GIT for any files. I store code, images, notes, documentation, help files and even database schema, all in one place. Basically everything except the executable and the database. So a version branch has all the related information. There is absolutely no issue storing binary files in GIT, apart from more storage (as you have noted).

— Rohit Gupta · ▲ 2

You can do what you are describing, it will just use more space. Below I give an alterative approach that is closer to how Git is intended to be used that allows for in-document change tracking and significantly smaller file sizes. Ideally your PDFs would be generated from a text-based input such as LaTeX and then you would have the source in one place and be able to see differences between versions as intended with Git. While you can, you should not use Git for generated files such as PDFs and instead these should be uploaded as releases on GitHub/GitLab. You should also track the script used

— Henry Ginn · ▲ 1

원글 열기

같은 문제의 다른 스레드

개발 도구·인프라 (7)