はじめに
本職が業務用海外アプリの販社のアプリケーションサポートなので、ユーザーや開発元とのやり取りで不具合が出る操作手順を画面キャプチャして手順書を残すことがよくあります。
たいていはWinshotで特定のフォルダに一旦、画面コピーをとにかく集めてからExcelに張り付けていくことになるのですがまあとにかくめんどくさい。
操作を動画に落とすのもありですが、どうしても冗長だしファイルサイズは過大だしでこれも気に入らない。
ところが、クリップボードにある画像をQiitaの編集画面に張り付けるとPNG画像としてアップロードしてくれるというのを読んだときにピピっと(死語)来た訳です。
さすがにQiitaを作業用に使うわけにもいかないので、Knowledgeの編集画面にペーストするとQiita同様にPNG画像がアップロードされたので、これを下書き＆画像収集に使用してSphinxで清書できないかと考えた。
1つ目の手順書作成が結構うまくいったので、忘備録もかねて記事にしました。
作業環境
- いつものSurface3 (Win10)
- Sphinx 1.6.5
- インストール仕様は以前の記事を参照
- Phython 3.6
- sphinx-quickstart-plus を追加
- Pandoc 2.0.1
-
画面コピーの取得用に FreeScreenshotWin version 1.4.7Win10の標準機能とコンフリクトするので、Ctrl+Home でアクティブウインドウをクリップボード転送できるように設定した- あとでよくよく調べたらWin10の標準機能で Alt+PrtScn すればアクティブウインドウをクリップボード転送(しつつOnedriveに保存)してくれる
-
Knowledge v1.11.0 を作業検証用なのでSurface3のローカルに導入
- Apache Tomcat Version 8.5.23
- JAVA (jdk1.8.0_131)
2017/12/13 追記
- 以下のWebブラウザでクリップボード画像の貼り付けを確認
- Microsoft Edge
- Chrome
作業手順
| # | 工程名 | 内容 |
|---|---|---|
| 0 | 記事作成 | Knowledgeに工程ごとに記事を作成する。画面コピーはアクティブウインドウをコピペして、見出しと注釈を入れながらどんどん貼り付ける |
| 1 | mdファイル作成 | ソースをコピペして作成 |
| 2 | index.rstファイル作成 | 工程ごとのmdファイル名を並べて記述 |
| 3 | URLリンク修正 | "相対URLを絶対URLに置き換え /knowledge/open.file/download -> http://localhost:8080/knowledge/open.file/download |
| 4 | コードブロック置き換え | Markdownのコードブロックを、eval_rst を使ってreStructureTextの1行x1列のSimpleTableに置き換え |
| 5 | 見出しの整理 | 元の記事のタイトルをH1(#)、記事中の見出しはひとつづつレベルを落とす。(# -> ##,## -> ### とか) ※ 見出しに数字は付記しない(バグる) |
| 6 | Sphinxでmake | make singlehtml |
| 7 | Chrome で表示確認 | 表示の乱れがないか確認する |
| 8 | Chrome で保存 | "リンク先の画像をローカルに保存する その他の操作->ファイルに保存->HTML(完全) ※ファイル名に空白文字を含まないように注意" |
| 9 | Pandoc変換 | pandoc <ファイル名>.html -o <ファイル名>.docx |
| 10 | 表の修正 | 表の幅を変更する(あるいは無指定にする) |
| 11 | 段落文字の削除 | ¶を削除する |
| 12 | 目次の削除 | リンク先がおかしいので削除する。必要であればWORD内で生成する |
| 13 | 奥付の削除 | 自分的にはいらないので、Indices and tablesを削除 |
結果
これで、社内向けにはknowledgeで公開しつつ、外部への提出用にはWordできれいにして出すことができました。
コードブロックをSimpleTableに置き換える操作が面倒ですが、80ページ/4000文字/画面コピー80枚/45個のコードブロックの作業手順書のWORD文書が、操作再生の手間(≒キャプチャの時間)＋半日分ちょっとの作業でできました。