「Sphinxをはじめよう」を読んで導入したいと思ったので色々考えてみた

Tags: [ Sphinx ] Published: 2013/10/25

あらすじ

今までちびちび触ってきたが「Sphinx をはじめよう」を読んで、改めて Sphinx を導入したいと考えた。

そこで、今の環境でどうやったら導入できるのか色々考えてみたが、相談できる人もいないのでここにアップしてみる。

本当は説得材料をつらつらと上げて「だから試してみよう」ってところに持って行きたかったんだけど、そこまでは行けていない。ダラダラ書いている。

テーマ

  • 適材適所

決して Office ディスではなく。色々なツールが適材適所で LET US CLING TOGETHER できる道を考えたい。

結論

  • ドキュメント
    • Sphinx
  • 複雑な表や表計算が必要な資料
    • Excel で別添資料扱い?
  • その他こまい文書
    • Redmine とかの Wiki に書き換え

って分けられると、幸せになれると考えている。。

Word は…思いっきり Sphinx と競合する気が…。

現在の己の認識

Office スタイル

今の主流。

長所

  • 超スタンダード(といわれている)
  • 誰の PC にも入っている(といわれている)
  • 誰でも簡単に使える(といわれている)
  • きめ細かいデザインが可能
  • 画像やフローの挿入も簡単

(「きめ細かい」とか「簡単」とかの定義がすごいめんどくさいんで、ここはふわっとした感じで)

これに加えて、下記のようなメンドクサイ作業をなんとな〜く作成可能なのは Office が一番有名なので他のツールへの移行がしづらいんではないかと個人的に思っている。

  1. 複雑な箇条書き
    • 1.1.章を作ってかなり間が空いてから 1.2.章(直前のリストの続き)とかを挿入したい
  2. エグい表 / テーブル
    • 結合、分割超使う。ヘタに行など追加すると死んでしまう
  3. 値の計算
    • Excel の独壇場。上のエグい表に「A列とB列を足した値をC列に追加」とか

短所

  • ちょっとしたメモから何まで Word, Excel で作成され共有フォルダに量産される
    • これは人にもよるか
  • どのドキュメントに何が書いてあるか探せない
    • みんなどうやって探し当てるの?
  • 設計書の修正前と後で diff がとりづらい、把握しづらい
    • 変更点を「変更履歴シートに書くことで履歴管理」するのが難しい。確実に忘れる。差分の確認むずい。運用で回避無理…
  • 誰かが誤ってレイアウトをいじるといろいろグチャグチャになる
    • リストの高さとかすぐいじっちゃう
    • フォーマットは壊さないというチームの結束がないと、あっという間にレイアウトにバラつきが出ると思うんだけどどうなんだろう
  • だいたい開くのに重い

Excel は メモや設計書ではなく 表計算部門などで活躍できるのはわかるが…。

Wiki, Jekyll Markdown スタイル

という事で、徐々に Wiki とか Markdown に傾倒していく。

長所

Wiki , Markdown などを使うことによって、以下の Office 短所 2 つはかなり解決できると思う。

  • 設計書の修正前と後で diff がとりづらい、把握しづらい
  • 誰かが誤ってレイアウトをいじるといろいろグチャグチャになる
  • バージョン管理ができて差分も楽に確認可能
    • Wiki はそういう機能が備わっているし、 Markdown はプレーンテキストなのでバージョン管理で管理できる
    • これは逆に短所にもなりうるが(バージョン管理ツールを使ったことない人とかもいるので)
  • デザインは css とかで統一できる

短所

  • どのドキュメントに何が書いてあるか探せない。

これは、カバーしきれないかもしれない。

Wiki でも量が多くなってくると、目的のファイルを探すのがきつくなってくる。

一応、エクスプローラーとかから探すよりは、 Wiki 内検索とかブラウザの Ctrl+F で探しやすいとは思うんだけど…。

その他の短所。

  • はじめて使う場合、記法を学ぶ必要がある
  • きめ細かいレイアウトの調整はめんどくさい
    • 統一されるが故に、「ここのリストだけちょっといじる」とかが、それ用にカスタマイズしないといけないため結構メンドクサイ
  • 画像やフローをドラッグアンドドロップ間隔で挿入することはできない
    • あらかじめ画像を作成しておいて画像記法とかで貼り付ける必要がある。現物(最終的な見栄え?)を見ながらいじれない

とはいえ、総合してまあ悪くないじゃん、っていうか、文章を残すという意味ではこちらの方が好み。

Sphinx スタイル

そして、先日発売した 「Sphinx をはじめよう」の 1.3 章 Sphinx と比較されるツール で、このもやもやを狙ったように Office , Wiki , Markdown + JekyllSphinx の比較が詳しくなされている。

内容は読んでもらうとして。

長所, 短所

基本的には、 Wiki , Markdown 組と同じ感じになるが、加えて Sphinx が他のツールとより良いと思ったところは、 ドキュメント的な体裁がすごく簡単に整えられる 所だと思った。

Sphinx を使って書かれているサイトを見ると(公式とか)、全体を抑えやすく、どの章を読みに行けばよいのかわかりやすいし、読み進めやすい。(当然、誰がどう書いても読みやすいってわけはなく、苦労の産物ではあると思うんだけど)

というわけで、成功するか失敗するかわからないし、導入方法から周知方法などいろいろ作る必要があるけど、 Office スタイルから Sphinx スタイルにコンバートしてみたいのが今の気持ち。

次はどう導入するかと、導入するにあたっての課題を考えてみる。

まだ Sphinx 自体 Hello World 程度しか触ってないんだけど!!


Author: kk_Ataka / Powered by Jekyll on GitHub Pages