SlideShare a Scribd company logo
1 of 15
Download to read offline
迷走(仮)
誰?
• プロデューサー
• 提督
• Application Engineer()
• コンピュータ関係の小さな輸入商社で、プリセールス、ポ
ストセールスでのサポート
• 主にデジタル系ハードウェア担当
• FPGA とか。
会社の環境
• ドキュメントは基本的に PowerPoint 又は Excel 。
• 「ページから文字溢れたらどうしてるんです?」
「次のページにカット&ペーストすればいいんじゃ?」
• テンプレートファイルなど存在しない。
• 当然、ヘッダ、フッタなどという概念は存在しない。
ページ番号は自分でふる。
• あんまりにもあんまりなので、同じ体裁のWordのテンプ
レートを作った。
ターゲット
• 「ハードウェア記述言語」の実習のテキスト
• 某校の5年生(基本20歳)向け
• 以前は専攻科2年生(基本22歳)向けだったものが、カリキュ
ラム変更で降りてきた
• C言語はいくらか書ける、Aruduino は経験がある、くらい。
• FPGA(プログラマブルなLSI)に回路を実装する実習。
• 実装する回路はストップウォッチ
• 前に担当していた先生が選んだ市販の教科書の内容があ
んまりにもあんまりで、かといって市販では自分が教え
られそうな本を見つけられなかったので、自力で作るこ
とに。
前夜
• Word
• 安易過ぎていやだ。
• Wordのリスト(章番号)が思ったように設定できない病気に
かかっている。
• 「エンジニアのためのWord再入門講座」のスタイルの作り
方のおかげでWordと和解できた気がする。
• 実習の補足の手順書は、前の先生のを引き継いでWordのま
ま。
• ペーパーテストもWordのまま。
• iBooks Author
• これからは電子書籍の時代だ。
• WYSIWYG 過ぎて断念。
DocBook
• XMLでWrite Once Publish Anytype
• HTML、EPUB、PDFなどなど
• e-novative GmbH(ドイツ)が e-novative DocBook Environment (eDE) と
いう環境を無償で配布していた(2012年に利用)。いろいろなツー
ルをひとまとめにして、Windows 上ではバッチファイルでいろい
ろ変換してくれる。
• AGYNAMIX 社?の DobuDish という環境もあった(2013年~2014年
に利用)
• 日本語の扱いに難があった
• XMLmind 社の XML editorを使って書いていた。段落単位でドラッ
グ&ドロップで順番入れ替えたりできた。
あとで有償になった。
• これ単体でもPDFは吐き出せたような……
• 出力したPDFの日本語が、UTFな実体参照(&XXXXのような)だった
のが気に入らなかった。検索できない。
• Apache FOP の制限で、PDFに埋め込む画像にベクターのが使えな
かった。
DocBook 例
←選択できるのに
↓検索できない
テキストエディタに
貼り付けると豆腐
EWB(挫折)
• あのアスキー様が実戦で使ってたんだからきっと素晴ら
しい環境なのではないか。
• 環境構築に手間取った。
• 自分の能力ではVooDoo的に使い方を覚えることができな
かった。
• 文章とスタイルが分かれているのはいいけれど、スタイ
ル作るのが結局わからなかった。
• EUC。
• 開発終了。サイトも無い。会社も無い。
TeX(保留)
• 仕事で一度書いたことがある。
• 書いたとおりに出てくるのはよい。
• 慣れてないので、出力が美しい気がする。
LyX
• 『LyXは、文書の外見(WYSIWYG)に頼った物書きではなく、
文書の「構造」(WYSIWYM)に基づいた執筆手法を支援する
文書プロセッサです。』
• 一応統合環境的で、「構造」が見えて分かりやすい。
• Write Once Publish Anytype 。
• ベクター画像も当然埋め込める。
• 2015年頃使用。
• ソースコードのエリアに日本語入れられなかった(当時)。
• 授業で使っているツールはそもそもソースファイル中のコメント
の日本語でも文法エラーになったりするものの、やはり説明のた
めに入れておきたい。
Sphinx (いまここ)
• Python のドキュメンテーションツール
• Write Once (略
• マークダウン的な記述。
• GitHub だとなんとなくレンダリングしてくれる。
• 2016年からこれで。
• 基本的な内容については満足。
• 実際に動作確認したソースコードを取り込んでくれる。
• LyXも同じで、PDF でデザイン少しでも良くしようとする
とLaTeX をゴリゴリいじらないといけない。
Re:VIEW (調査中)
• Adobe InDesign にインポートできるらしいじゃないです
か。デザイン少しいじりやすくなるんじゃないかって期
待したくなるじゃないですか。
• Sphinx のコードから移植中。
• 実際の所、前々から試してはいたものの、他のツール向け
に書いていた構造そのまま持ってこようとすると機能が足
りないということがあり、後回しになっていた。
図について
• Visio で作図。EMF(Enhanced Meta File) 形式で出力して、
何とか EPS に変換して LaTeX に流し込み。
• LyX に入っていた「Metafile to EPS Converter」が大活躍。
• Draw.io チャレンジしなきゃ……
• 挿絵も入れたい……
ファイル管理
• GitHub に登録済み。登録してあるだけで全く活用出来て
いない。CI とか。
ありがとうございました。
おまけ

More Related Content

Similar to ドキュメンテーションツールについて迷走した記録

Force.comシステム連携のデザイン考察
Force.comシステム連携のデザイン考察Force.comシステム連携のデザイン考察
Force.comシステム連携のデザイン考察Junji Imaoka
 
サポーターズ勉強会スライド 2018/2/27
サポーターズ勉強会スライド 2018/2/27サポーターズ勉強会スライド 2018/2/27
サポーターズ勉強会スライド 2018/2/27Kensuke Mitsuzawa
 
20121124 学生セミナー「基礎からわかる! IT業界とプログラミング」
20121124 学生セミナー「基礎からわかる! IT業界とプログラミング」20121124 学生セミナー「基礎からわかる! IT業界とプログラミング」
20121124 学生セミナー「基礎からわかる! IT業界とプログラミング」Takashi Uemura
 
Hadoop Source Code Reading #17
Hadoop Source Code Reading #17Hadoop Source Code Reading #17
Hadoop Source Code Reading #17Shingo Furuyama
 
うちの開発におけるXD利用法
うちの開発におけるXD利用法うちの開発におけるXD利用法
うちの開発におけるXD利用法Kazuma Sekiguchi
 
TOPPERS as an IoT OS(kernel)
TOPPERS as an IoT OS(kernel)TOPPERS as an IoT OS(kernel)
TOPPERS as an IoT OS(kernel)Kiyoshi Ogawa
 
About cloneko(與那城雄について)
About cloneko(與那城雄について)About cloneko(與那城雄について)
About cloneko(與那城雄について)Yuu Yonashiro
 
Kintoneでエンジニアが納得のいく社内システムをつくる
Kintoneでエンジニアが納得のいく社内システムをつくるKintoneでエンジニアが納得のいく社内システムをつくる
Kintoneでエンジニアが納得のいく社内システムをつくるKazuki Murahama
 
Firefox OS を使って HTML5 でハードウェアを動かしてみよう
Firefox OS を使って HTML5 でハードウェアを動かしてみようFirefox OS を使って HTML5 でハードウェアを動かしてみよう
Firefox OS を使って HTML5 でハードウェアを動かしてみようHonma Masashi
 
精神論によるいきいきとした組織づくりのご提案
精神論によるいきいきとした組織づくりのご提案精神論によるいきいきとした組織づくりのご提案
精神論によるいきいきとした組織づくりのご提案tod esking
 
ワイヤーフレームを高速にXDらしく作る
ワイヤーフレームを高速にXDらしく作るワイヤーフレームを高速にXDらしく作る
ワイヤーフレームを高速にXDらしく作るRisa Yuguchi
 
本の紹介
本の紹介本の紹介
本の紹介t w
 
ChatGPT(LLMによる生成系AI)の追加学習を No Code で行う ~ 概念モデリング教本を元に ~
ChatGPT(LLMによる生成系AI)の追加学習を No Code で行う  ~ 概念モデリング教本を元に ~ChatGPT(LLMによる生成系AI)の追加学習を No Code で行う  ~ 概念モデリング教本を元に ~
ChatGPT(LLMによる生成系AI)の追加学習を No Code で行う ~ 概念モデリング教本を元に ~Knowledge & Experience
 
インフラエンジニア勉強会hbstudyについて
インフラエンジニア勉強会hbstudyについてインフラエンジニア勉強会hbstudyについて
インフラエンジニア勉強会hbstudyについてToshiaki Baba
 

Similar to ドキュメンテーションツールについて迷走した記録 (20)

Python勉強会 2015-12-02
Python勉強会 2015-12-02Python勉強会 2015-12-02
Python勉強会 2015-12-02
 
Force.comシステム連携のデザイン考察
Force.comシステム連携のデザイン考察Force.comシステム連携のデザイン考察
Force.comシステム連携のデザイン考察
 
サポーターズ勉強会スライド 2018/2/27
サポーターズ勉強会スライド 2018/2/27サポーターズ勉強会スライド 2018/2/27
サポーターズ勉強会スライド 2018/2/27
 
20121124 学生セミナー「基礎からわかる! IT業界とプログラミング」
20121124 学生セミナー「基礎からわかる! IT業界とプログラミング」20121124 学生セミナー「基礎からわかる! IT業界とプログラミング」
20121124 学生セミナー「基礎からわかる! IT業界とプログラミング」
 
Hadoop Source Code Reading #17
Hadoop Source Code Reading #17Hadoop Source Code Reading #17
Hadoop Source Code Reading #17
 
うちの開発におけるXD利用法
うちの開発におけるXD利用法うちの開発におけるXD利用法
うちの開発におけるXD利用法
 
Rakuten20181027
Rakuten20181027Rakuten20181027
Rakuten20181027
 
TOPPERS as an IoT OS(kernel)
TOPPERS as an IoT OS(kernel)TOPPERS as an IoT OS(kernel)
TOPPERS as an IoT OS(kernel)
 
About cloneko(與那城雄について)
About cloneko(與那城雄について)About cloneko(與那城雄について)
About cloneko(與那城雄について)
 
Kintoneでエンジニアが納得のいく社内システムをつくる
Kintoneでエンジニアが納得のいく社内システムをつくるKintoneでエンジニアが納得のいく社内システムをつくる
Kintoneでエンジニアが納得のいく社内システムをつくる
 
Pentaho ETL
Pentaho ETLPentaho ETL
Pentaho ETL
 
Firefox OS を使って HTML5 でハードウェアを動かしてみよう
Firefox OS を使って HTML5 でハードウェアを動かしてみようFirefox OS を使って HTML5 でハードウェアを動かしてみよう
Firefox OS を使って HTML5 でハードウェアを動かしてみよう
 
Lt1
Lt1Lt1
Lt1
 
精神論によるいきいきとした組織づくりのご提案
精神論によるいきいきとした組織づくりのご提案精神論によるいきいきとした組織づくりのご提案
精神論によるいきいきとした組織づくりのご提案
 
ワイヤーフレームを高速にXDらしく作る
ワイヤーフレームを高速にXDらしく作るワイヤーフレームを高速にXDらしく作る
ワイヤーフレームを高速にXDらしく作る
 
本の紹介
本の紹介本の紹介
本の紹介
 
ChatGPT(LLMによる生成系AI)の追加学習を No Code で行う ~ 概念モデリング教本を元に ~
ChatGPT(LLMによる生成系AI)の追加学習を No Code で行う  ~ 概念モデリング教本を元に ~ChatGPT(LLMによる生成系AI)の追加学習を No Code で行う  ~ 概念モデリング教本を元に ~
ChatGPT(LLMによる生成系AI)の追加学習を No Code で行う ~ 概念モデリング教本を元に ~
 
インフラエンジニア勉強会hbstudyについて
インフラエンジニア勉強会hbstudyについてインフラエンジニア勉強会hbstudyについて
インフラエンジニア勉強会hbstudyについて
 
ソフトウェアとは
ソフトウェアとはソフトウェアとは
ソフトウェアとは
 
私とOSSの25年
私とOSSの25年私とOSSの25年
私とOSSの25年
 

ドキュメンテーションツールについて迷走した記録