納品ドキュメントの作成にMarkdown+Vivliostyleを採用した話 - Qiita

こんにちは、製造業でソフト開発エンジニアをやっているとみー(@tommyecguitar)です。 会社で納品物の説明ドキュメントを作ることがあり、その時にMarkdownでの組版をやってみたので、どう運用したか、困ったところ、いい点、悪い点をまとめてみようと思います。 Vivliostyleで組版したブログはたくさんあるので、見た目がどんな感じにできるかなどはそちらを見ていただくか、Vivliostyleのサイトをご覧ください。 Wordじゃだめなのか。 製造業で何かしら長大なドキュメントを作るとなったら、大抵はWordを複数人数で編集するという運用をしているところが多いと思います。 しかし、Wordにはいろいろと悪いところがあります。 チーム内で共同編集すると、編集したところが消えたり、フォントやデザインがなぜか統一されなかったりする。 セクションごとに担当を分けても、マージが手作業にな

[d6rkaiz]

アウトプットがどうなるかだけ気になるな。 / サンプルで良いんだよサンプルで。誰も本物のドキュメントなんて望んでない。/ ← とあるブコメに対してのもので書いた人に対したものではありません

[programmablekinoko]

成果物見せてくれないの->普通の製造業が見せられるわけ無いだろ

[igni3]

Wordを置換できる条件は「何も学ばなくてもいきなり使える」「10年以上耐用する」なんよ

[ghashi]

texとか卒業してから使わなくなったけどコスト高すぎるよなぁ、DaCの是非と手段の正解

[BOOOOOOOON]

どうして成果物を見せてくれないの？　こんなに手間のかかることをするだけのアウトプットってどういうものなの/現物見せてなんて言ってないだろ、exampleでじゅうぶんなのに全くイメージつかない

[new3]

最近はpdfにするならAsciidoctor、webならdocusaurus　になっているが一部にはやっぱりWYSIWYGじゃないとダメ派が根強く、テンプレ決めて内容詰め込んで最後微調整するより書きながら細かい見た目を気にする人間のサガを感じる

[TakamoriTarou]

製造業でこれができるのはでかいなあ。　大規模ドキュメントを作るためのドキュメントプロセッサがあるけど（構築に数千万円とかかかる）その中核機能をほぼオープンソースのソフトだけで実現してる感じがする。

[htnmiki]

人柱にさせられる客が不憫だがこうした取り組みでより良い世界へ向かうなら頑張ってください

[boraneko]

製造業でこれやるのかあ 推進してくれる人がいるっていいね 大抵は仕事が増えて給料も上がらないからこういうことやってくれる人少ないんだよね

[Okaz]

MarkdownをWordに変換できたら最高だよね。

[hokorobi]

納品物のドキュメントは納品後に変更することもあるので多くの人が変更できる形式がいいな。

[yoshikie]

サンプル出せ！とか喚いている人はいったい何目線なんだろうか。気になるなら自分で手を動かせばいいのに。自分で手を動かす人のためにナレッジ共有してる記事でしょコレ

[ryunosinfx]

納品ドキュメント、お客がOfficeかブラウザでしか開く能がないから神ExcelやWord、PDFになっている納品ドキュメントの話じゃないかー！あー差分管理したい。Officeにお別れを告げたい。

[arx0balest]

mdの良さの一つであるベンダーロックイン回避が失われるのがな。WordやJira/ConfluenceとかいうクソEvilな公害サービスよりはマシに見えるが。

[sfken]

ここまでするならTeXで良い気もしてしまう。

[kaz_hiramatsu]

ドキュメントの作成でここまで開発力求められるのはちょっと。teamsのファイル共有いいよ

[dec123456789]

多分Wordファイルをファイルサーバーに置いて皆でいじってるんだろうけど、ここまで抜本的に変える前にMicrosoft 365試してからでも遅くはないと思う

[Bryntsalov]

google docsでいいんじゃない？

[tettekete37564]

良いね後

[hkmn]

> 成果物 ぐぐれ、ためせ

[asahiufo]

みんなMarkdownの方言対応ってどうやってるのか気になる。

[daishi_n]

TeXの再発明になってるような気もするが、やってみることに意義がないわけではない

[kobito19]

今どきWordつったらweのやつだと思うがそれと比べてどうなん。これどのバージョンと比較してんの

[diet55]

VSCode+Markdown + Markdown Preview Enhanced+Vivliostyle（独自スタイルのVFM）

[hatebu_ai]

あのお絵描きAIを活用したのかと思った／ドキュメントもAIが書くようになってくれたらいいな？

[tinsep19]

mdのテキストのままが読みやすいを大事にしたくて、スタイリングの為の何かを書くのが嫌。俺にはMarkdownのドキュメントツールは合わないんだと思う

[xlc]

Markdownを使うことが目的化してないか？

[MtAsuka]

1つの文書を分割して複数人で編集したいならWordのグループ文書機能使えばいいのでは？

[typographicalerror]

pandocでがんばって変換してた時期があったけど、最後までMarkdownでいけるならいいな

[Derabon]

メモ

[BlueSkyDetector]

ほぼ同じ目的でRe:VIEWを導入して正式な製品ドキュメント(pdf)に使えてる。Re:VIEWが良かったのはカスタムしたいところはLaTeX由来の柔軟(で複雑)な表現ができる点。客先に出せる品質にできた。試してないけどInDesign形式も。

[moromoro]

"セクションごとに担当を分けても、マージが手作業になってしまう。" Wordは章ごと分冊、PDFで全冊は許されんのやろか

[strawberryhunter]

WYSIWYGがいいし、図表にも不自由したくない。{.class-name}は自由度が増えて逆によろしくない気がする。でもテキストで書きたいとはずっと思っている。