開発ツール・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)