正月早々３日坊主ならぬ２日坊主だった隠者です。
いや、年末年始の甥っ子姪っ子の攻撃ですっかりHPがゼロでしたので・・・。
コミケで買って来たおもちゃの猫絵のお札をプレゼントしたら、同じ額の本物のお札欲しいなって幼稚園児にねだられて困りました。１万猫が５枚、五千猫が５枚、千猫が５枚ですからねぇ。
どうやら、お駄賃とかでお金を蓄えさせて、欲しいものは自分で買わせてるとの事で、幼稚園児なのにお金に興味津々のようでした。あの年頃は、紙のお金で売買ごっこなんじゃないのかな。ゲーム買うにはあといくらで・・・を真面目に計算する幼稚園児は怖いです。
さて、コミケで売り子をやっていたので、開店直後にテクブのブースに並んで、テクブ本購入してきました。
中でも、一番気になっていたのが、ReVIEW本です。
ReVIEWは、軽量マークアップ形式であるReVIEW記法を使ってテキストベースで書いた内容をEPUBやPDFに変換してくれるツールです。
実は、隠者のお客様はドキュメントについての定型というものがありません。人によっては、Textで書く人、Wordで書く人、HTMLで書く人をはじめ、Excelで書く人や中にはPowerPointで書く人までいる状況でして。正直よくないと考えています。
そこで、お客様にこの辺りのドキュメントのフォーマットを統一できないかという話をしたくて、だいぶ前にこの手のツールを調べていました。
既に個人的にはReVIEWではなくSphinxを使ってドキュメントを用意するようにつとめているのですが、TLではReVIEWを使っている人が多いようなので、もしかしたらReVIEWの方が国内では流行るのかもという気もしていて、今後の動向が気になっています。
ReVIEWは、Rubyのソースコード完全解説本や、Rubyを256倍使う本の無道編の著者である、青木峰郎さんが作成され、現在は、独習○○系本で良く名前をお見かけする武藤健志さんをはじめとする方々がメンテナンスをされている、書籍を書く事に重点を置いて作成されているツールのようです（調べてたくせに制作者がこの方々とは知らなかった）。
ReVIEW本では、環境の構築から、簡単なドキュメントの生成、スタイルをつかった整形まで、電子書籍等を作る場合に必要になりそうな基礎がしっかり入っていました。
特に、悩みそうなスタイル部分と、コマンドの解説のあたりは重宝しそうです。
ちなみに仕事で使うつもりといったSphinxですが、こちらはPythonで書かれたツールで、reStructuredText記法を使ってテキストベースで書いた内容をHTMLやPDFやEPUB形式に変換してくれるツールです。まぁ、ReVIEWと思いっきりかぶっているのですが、使った感触では、ReVIEWは書籍のような出版系に、Sphinxの方はHTMLベースでの運用も含めた仕様書やマニュアル系に向いている気がしています(注：個人的な感想ですが）。
ReVIEWの方の調査は半端で止めてしまった（というか、仕事の環境の都合で早めに断念した）ため拡張方法は不明ですが、Sphinxはいろいろと拡張できるように設計されているようで、拡張モジュールもいくつか提供されていて、特にテキストでの表記から図を生成できる、blockdiagとかmscgenとかinheritance_diagramとか、慣れは必要なものの便利な機能もあったりします。
取っ付きやすさと面でいうと、機能がしぼられている分、ReVIEWの方が取っ付きやすいように思いますけど、仕様書のために使いたいと思うと、少し物足りない感がありますね。
ただ、Sphinxの残念なところは、PDF化の時に、なんだか思い通りに出力させるのが大変だった気がしています。とりあえず、仕事上はHTMLでも十分な感じなので、一応は満足しているのですが。
何にせよ、どうせなら仕様書もテキストベースに切り替えて、きっちりバージョン管理したいものですねぇ。
2014年1月6日月曜日
2014年1月2日木曜日
Qtのバグレポートを書いてみました
甥っ子と姪っ子の相手でふらふらの隠者です。この子供達と毎日つきあうと思うと、弟夫婦には頭が下がる思いです。
さて、そんな二人が寝静まった後、先日見つけた間違いのうち、Qt5.2のMac版では、PluginPackageMac.cppが使われていない問題を初バグレポートしてみました。
どうやってバグをレポートするのかについての紹介は以下のサイトにあります。
アカウントが用意されたら、まずはJIRAのIssueリストで類似の問題が無いか、キーワードを考えて右上のQuick Searchで検索してみます。が、この検索、デフォルトでCloseされた問題も一緒に検索したり、バージョン指定で検索しにくかったり、いまいち使いにくいですね。JIRAには結構期待してたのにちょっと残念。
まぁ、重複登録しないにこした事はないのですが、考えたキーワードで見当たらなければ仕方が無いので、バグを登録してしまいましょう。
Issueのページには、Create Issueのボタンがありますので、それをクリックすると、バグ登録のページが表示されます。
バグ報告の場合、ProjectはQt、Issue TypeはBugのままで良いです。
Summaryには、バグを簡潔かつ具体的に記載するのが良さそうです。長過ぎたり、曖昧だったり（うまく動かないみたいな記載は駄目）するのは良くないです。
Affects Version/sには、問題が発生するバージョンを記載します。今回は、Qt 5.2.0の検証のために、v5.2.0をチェックアウトしたコードで試したので、5.2.0を選択しました。
Component/sでは、問題の根本原因と思われるコンポーネントを選択します。今回は、WebKitを選択しました。
Descriptionは、説明になります。一般的には
・何をしたのか１ステップずつ再現に必要な手順を記載する
・何を期待したのか記載する
・何が起きたのか期待する
といった事を書くと良いようです。
Environmentは、問題の再現した環境の説明になります。
・使用しているコンパイラ名とバージョン
・使用しているOS名とバージョン
・Qtのバージョンやその構成（ビルドしたQtならconfigureのオプションとかも入れるとよさそう？）
今回は、問題の原因に近い部分まで探っていたので、Descriptionについては、どこの変更が原因で、何が動いて、どうなったのかを、なんちゃって英語で軽く書いて見ました。こういうの書くと、英語のスキルの無さが露呈して、悲しくなりますね・・・。
https://bugreports.qt-project.org/browse/QTBUG-35899
入力して３日も立たずに、これを試してくれというメッセージが追加されました。
https://codereview.qt-project.org/#change,74564
修正内容は、おおよそは調べていたものと同じですが、こちらで考えた修正では足りてない部分もあったようです。まぁ、残念ながら実家の貧弱な回線だとgit fetchがさっぱり終わらず（というか途中で止まる）、まだ試せていませんが、自宅に帰り次第試してみたいなと思います。
まぁ、上記で記載したバグのレポートが、Qtのプロジェクトに貢献する一番楽な部類になるのではないかと思います。さらに進んだ貢献をしたいという方は、以下のURLを参考にがんばってみて下さい。
http://qt-project.org/contribute
Summaryには、バグを簡潔かつ具体的に記載するのが良さそうです。長過ぎたり、曖昧だったり（うまく動かないみたいな記載は駄目）するのは良くないです。
Affects Version/sには、問題が発生するバージョンを記載します。今回は、Qt 5.2.0の検証のために、v5.2.0をチェックアウトしたコードで試したので、5.2.0を選択しました。
Component/sでは、問題の根本原因と思われるコンポーネントを選択します。今回は、WebKitを選択しました。
Descriptionは、説明になります。一般的には
・何をしたのか１ステップずつ再現に必要な手順を記載する
・何を期待したのか記載する
・何が起きたのか期待する
といった事を書くと良いようです。
Environmentは、問題の再現した環境の説明になります。
・使用しているコンパイラ名とバージョン
・使用しているOS名とバージョン
・Qtのバージョンやその構成（ビルドしたQtならconfigureのオプションとかも入れるとよさそう？）
今回は、問題の原因に近い部分まで探っていたので、Descriptionについては、どこの変更が原因で、何が動いて、どうなったのかを、なんちゃって英語で軽く書いて見ました。こういうの書くと、英語のスキルの無さが露呈して、悲しくなりますね・・・。
https://bugreports.qt-project.org/browse/QTBUG-35899
入力して３日も立たずに、これを試してくれというメッセージが追加されました。
https://codereview.qt-project.org/#change,74564
修正内容は、おおよそは調べていたものと同じですが、こちらで考えた修正では足りてない部分もあったようです。まぁ、残念ながら実家の貧弱な回線だとgit fetchがさっぱり終わらず（というか途中で止まる）、まだ試せていませんが、自宅に帰り次第試してみたいなと思います。
まぁ、上記で記載したバグのレポートが、Qtのプロジェクトに貢献する一番楽な部類になるのではないかと思います。さらに進んだ貢献をしたいという方は、以下のURLを参考にがんばってみて下さい。
http://qt-project.org/contribute
2014年1月1日水曜日
新年あけましておめでとうございます
昨日は初コミケかつ初サークルお手伝いだった隠者です。
年が明けたにも関わらず、昨日のイベント疲れか、いまいち新しい気持ちに成れていませんが、皆様は良い年を迎えられましたでしょうか。
さて、昨日はできなかったので、とりあえずこの１年を振り返り、今年を考えてみようかと。
個人事業を始めて２年と数ヶ月に成るわけですが、もうドタバタした１年でした。落ち着くかと思った矢先にといった感じで色々起こっては、常に何かしら騒ぎの渦中にいた感じでした。Twitterでは割合と明るい内容で過ごしていましたけど、フリーランスなんて社会の底辺で食っている技術者ですから、不安とプレッシャーの中の綱渡りで、冷や汗たらたらで立ち回る日々ですよ、いや、本当に。
どれほど忙しくても、勉強会にはそこそこ出席し、ツイッターでアホな事をつぶやきつつも、お客様の信頼を失わないように、必要な情報を集めて回る。自分の範疇の外にある事も、とにかく解決策を模索して、お客様と一緒に悩み、困りながら、何かしらの道を探す。あまり有益な結果を残せなかったのではないかという後悔と、自分の至らなさへの憤りで過ごす。そんな日々でした。
冬に成る頃には、なんとかひと心地ついて、仕事も開発に戻っての年末を迎えられたので、今年こそは・・・・いえ、フラグを立てるのは、もうやめましょう。
プライベート的には、2012年の秋以降、こちらの不義理で関係が途絶えてしまったネトゲ仲間とは全く連絡が取れなくなってしまって、昨年落ち着き始めてからしばらく、後悔の日々も過ごしましたが、まぁ、ネットだけの付き合いなんてものは、一度切れてしまうともうどうしようもないものですし、後ろを向いて生きられる程残りの人生長くないので、詫びのメッセージだけ一方的に送りつけて、あまり深く考えない事にしました。ごめんなさい。
両親の体調不良も落ち着いた後は、僕個人の体調が少し崩れていましたけど、幸い無事に乗り切りました。プライベート的には、大きな出来事的なものはその程度でしょうか。
さて、昨年の抱負として課題に挙げたものは、
だったわけですが、どれもあまり学習が進展しませんでした。変わりに艦メモをちょっといぢろうとしながら、独り秋の夜長に、うっかりゲームの方にはまってしまう始末でして。何一つ成し遂げられなかったようにも思います。
で、Qt 5.2が出た現在の抱負ですが、Qt 5.2の品質の悪さに愕然としつつ、少しQtに貢献でする必要があるかとも感じています。
また、個人的には少し体調を崩して色々検査したりもあったので、年も年なので、体調にも気を使いながら、ドタバタで消耗した自分のペースをつかみ直す一年にしたいなと思います。
まぁ、そんなわけで
年が明けたにも関わらず、昨日のイベント疲れか、いまいち新しい気持ちに成れていませんが、皆様は良い年を迎えられましたでしょうか。
さて、昨日はできなかったので、とりあえずこの１年を振り返り、今年を考えてみようかと。
個人事業を始めて２年と数ヶ月に成るわけですが、もうドタバタした１年でした。落ち着くかと思った矢先にといった感じで色々起こっては、常に何かしら騒ぎの渦中にいた感じでした。Twitterでは割合と明るい内容で過ごしていましたけど、フリーランスなんて社会の底辺で食っている技術者ですから、不安とプレッシャーの中の綱渡りで、冷や汗たらたらで立ち回る日々ですよ、いや、本当に。
どれほど忙しくても、勉強会にはそこそこ出席し、ツイッターでアホな事をつぶやきつつも、お客様の信頼を失わないように、必要な情報を集めて回る。自分の範疇の外にある事も、とにかく解決策を模索して、お客様と一緒に悩み、困りながら、何かしらの道を探す。あまり有益な結果を残せなかったのではないかという後悔と、自分の至らなさへの憤りで過ごす。そんな日々でした。
冬に成る頃には、なんとかひと心地ついて、仕事も開発に戻っての年末を迎えられたので、今年こそは・・・・いえ、フラグを立てるのは、もうやめましょう。
プライベート的には、2012年の秋以降、こちらの不義理で関係が途絶えてしまったネトゲ仲間とは全く連絡が取れなくなってしまって、昨年落ち着き始めてからしばらく、後悔の日々も過ごしましたが、まぁ、ネットだけの付き合いなんてものは、一度切れてしまうともうどうしようもないものですし、後ろを向いて生きられる程残りの人生長くないので、詫びのメッセージだけ一方的に送りつけて、あまり深く考えない事にしました。ごめんなさい。
両親の体調不良も落ち着いた後は、僕個人の体調が少し崩れていましたけど、幸い無事に乗り切りました。プライベート的には、大きな出来事的なものはその程度でしょうか。
さて、昨年の抱負として課題に挙げたものは、
- Wayland
- Qt/QML
- Silk
だったわけですが、どれもあまり学習が進展しませんでした。変わりに艦メモをちょっといぢろうとしながら、独り秋の夜長に、うっかりゲームの方にはまってしまう始末でして。何一つ成し遂げられなかったようにも思います。
で、Qt 5.2が出た現在の抱負ですが、Qt 5.2の品質の悪さに愕然としつつ、少しQtに貢献でする必要があるかとも感じています。
また、個人的には少し体調を崩して色々検査したりもあったので、年も年なので、体調にも気を使いながら、ドタバタで消耗した自分のペースをつかみ直す一年にしたいなと思います。
まぁ、そんなわけで
- 医者に勧められたのでダイエット
- Qt/QMLの勉強・普及促進・学習
- 艦メモ
あたりが、とりあえず今年の前半の抱負になるでしょうか。
え、昨年に比べてもさらにいい加減すぎるって？まぁ、なんだ。１年ドタバタやって気がついた事は、根っから真面目に何かに取り組んだとしても、解決しない事は解決しないって事でしょうか。
少しゆるいくらいで先を見て、少しぬるいくらいで前を目指して、少しずつやってくしか無いんですよね、人生なんてものは。
というわけで、新年早々ですが、のほほんとのんびりがんばりますので、今年もどうぞよろしくお願いいたします。
登録:
投稿 (Atom)