my_help 0.4.5 → 0.5.0

data/docs/nasu/latex_dir/features.tex

@@ -0,0 +1,186 @@
+
+\subsection{featuresでの記述とその意味}
+featuresでの記述は，コマンドの振る舞いを説明する自然な記述です．
+その様子をspecific\_helpが用意しているデフォルトのコマンドについて説明します．
+specific\_helpとは，ユーザが作成するそれぞれのヘルプです．
+speific\_helpの--helpを表示させると，
+\begin{lstlisting}[style=customCsh,basicstyle={\scriptsize\ttfamily}]
+        --edit                       edit help contentsを開く
+        --to_hiki                    hikiのformatに変更する
+        --all                        すべてのhelp画面を表示させる
+        --store [item]               store [item] でback upをとる
+        --remove [item]              remove [item] back upしてるlistを消去する
+        --add [item]                 add new [item]で新しいhelpを作る
+        --backup_list [val]          back upしているlistを表示させる
+\end{lstlisting}
+が得られます．
+これらの項目について順に詳細な振る舞いとそれを記述するシナリオを検討していきます．
+
+\subsubsection{--add [item]}
+このコマンドは新しいitemをspecific\_helpに追加します．
+提供される機能をシナリオの先頭に内容をかいつまんでこの振る舞いが記述されています．
+実装では，ヘルプの内容は~/.my\_help/emacs\_help.ymlに元dataがあります．
+\begin{lstlisting}[style=customRuby,basicstyle={\scriptsize\ttfamily}]
+nasu% cat add.feature
+#language: ja
+
+#--add [item]
+機能: 新しいitemをspecific_helpに追加する
+specific_helpとは，ユーザが作成するそれぞれのヘルプである
+新しいhelp画面を追加したい
+
+シナリオ: コマンドを入力してspecific_helpにitemを追加する
+        前提 新たなhelpコマンドを追加したい
+        もし emacs_help --add[item]を入力する
+        ならば ~/.my_help/emacs_help.ymlに新しいitemが自動的に追加される
+
+\end{lstlisting}
+\subsubsection{--all}
+このコマンドはspecific\_helpにあるhelpを一度に全て表示させます．
+するとspecific\_helpにあるitemを全て表示します．
+実装では，元データが~/.my\_help/emacs\_help.ymlにあるので，それを全て表示します．
+\begin{lstlisting}[style=customRuby,basicstyle={\scriptsize\ttfamily}]
+nasu% cat all_help.feature
+#language: ja
+
+#--all
+機能: 全てのhelp画面を見る
+複数のhelp画面を一度に見たい時に便利である
+
+シナリオ: コマンドを入力してすべてのhelpを見る
+        前提 複数のhelp画面を表示したい
+        もし emacs_help --allと入力する
+        ならば すべてのhelp画面が表示される
+\end{lstlisting}
+\subsubsection{--backup\_list}
+このコマンドは過去にバックアップをとったことのあるitemを表示させます．
+自分がどのitemをバックアップしたのかの確認ができます．
+また，そのitemのバックアップをとった時間も表示されるので，いつバックアップをとったのかの確認もできます．
+\begin{lstlisting}[style=customRuby,basicstyle={\scriptsize\ttfamily}]
+nasu% cat backup_list.feature
+#language: ja
+
+#--backup_list
+機能: 過去にバックアップしてあるitemのリストを表示させる
+何をバックアップしたかの確認をしたい
+
+シナリオ: コマンドを入力してバックアップのリストを見る
+        前提 バックアップのリストを見たい
+        もし emacs_help --backup_listを入力する
+        ならば バックアップしているitemのリストが表示される
+        
+\end{lstlisting}
+\subsubsection{--edit}
+このコマンドはspecific\_helpのitemの編集ができます．
+実装では，元データのある~/.my\_help/emacs\_help.ymlがemacsで開かれ，自分で編集ができます．
+編集作業が終了したら，emacsで開かれているので， [C-x C-s]で保存，[C-x C-c]でeditを閉じます．
+\begin{lstlisting}[style=customRuby,basicstyle={\scriptsize\ttfamily}]
+nasu% cat edit_help.feature
+# language: ja
+#--edit
+機能: helpコマンドの追加や削除，編集をするためのeiditを開く
+emacs_helpと入力したときに出てくるhelpのコマンドの追加や削除，編集ができる
+
+シナリオ: コマンドを入力してeditを開く
+        前提 emacs_helpのコマンドの編集がしたい
+        もし emacs_help --editと入力する
+        ならば ~/.my_help/emacs_help.ymlがemacsで開かれる
+\end{lstlisting}
+\subsubsection{--remove [item]}
+このコマンドは新しいitemをspecific\_helpから削除します．
+提供される機能をシナリオの先頭に内容をかいつまんでこの振る舞いが記述されています．
+実装では，ヘルプの内容は~/.my\_help/emacs\_help.ymlに元dataがあります．
+\begin{lstlisting}[style=customRuby,basicstyle={\scriptsize\ttfamily}]
+nasu% cat remove.feature
+#language: ja
+
+#--remove [item]
+機能: specific_helpのitemを消す
+いらなくなったitemを消したいときに使う
+
+シナリオ: コマンドを入力してitemを消す
+        前提 いらないitemを消したい
+        もし emacs_help remove [item]
+        ならば ~/.my_help/emacs_help.ymlからitemが消える
+
+\end{lstlisting}
+\subsubsection{--store [item]}
+このコマンドはspecific\_helpのitemのバックアップをとります．
+少しhelpを新しくしたいが，過去のhelpを残しておけば安心できます．
+~/.my\_helpディレクトリーの中に，同じ名前の先頭に'.'をつけたファイルに追記されていきます．
+\begin{quote}\begin{verbatim}
+-rw-r--r--   1 bob  501   3231  2 10 17:11 my_todo.yml
+-rw-r--r--   1 bob  501  31925  2  3 19:49 .my_todo.yml
+\end{verbatim}\end{quote}
+などとしてます．
+\begin{lstlisting}[style=customRuby,basicstyle={\scriptsize\ttfamily}]
+nasu% cat store.feature
+#language: ja
+
+#--store [item]
+機能: itemのバックアップを取る
+バックアップとして残したいitemがあるときに使う
+
+シナリオ: コマンドを入力してitemのバックアップをとる
+        前提 バックアップをとっておきたい
+        もし emacs_help --store [item]と入力する
+        ならば 入力したitemのバックアップが作られる
+\end{lstlisting}
+\subsubsection{--to\_hiki}
+このコマンドはformatをhikiに変更します．
+\begin{quote}\begin{verbatim}
+:カーソル移動:cursor
+*C-f, move Forwrard,    前or右へ
+*C-b, move Backwrard,   後or左へ
+*C-a, go Ahead of line, 行頭へ
+*C-e, go End of line,   行末へ
+*C-n, move Next line,   次行へ
+*C-p, move Previous line, 前行へ
+\end{verbatim}\end{quote}
+などとhiki記法で出力されます．これをhikiの本文中に入れると
+\begin{description}
+\item[カーソル移動] cursor
+
+\end{description}
+\begin{itemize}
+\item C-f, move Forwrard,    前or右へ
+\item C-b, move Backwrard,   後or左へ
+\item C-a, go Ahead of line, 行頭へ
+\item C-e, go End of line,   行末へ
+\item C-n, move Next line,   次行へ
+\item C-p, move Previous line, 前行へ
+\end{itemize}
+などとweb上で表示されます．
+\begin{lstlisting}[style=customRuby,basicstyle={\scriptsize\ttfamily}]
+nasu% cat to_hiki.feature
+# language: ja
+
+#--to_hiki
+機能:formatをhikiモードに変更する
+一つ一つエディタで開いて変更するのがめんどくさい時に有益である
+
+シナリオ: コマンドを入力してformatをhikiモードに変える
+        前提 hikiモードに変更したい
+        もし emacs_help --to_hikiと入力する
+        ならば formatがhikiモードに変更される
+\end{lstlisting}
+\subsubsection{todoの更新}
+まず，todoを書き込むために，editを開くために，my\_todo --editと入力します．
+--editコマンドは上記で説明した動きをします．
+しかし，ここでは元データは~/.my\_help/todo\_help.ymlです．
+editが開かれたら，todoを書き込みます．（今週やることならweeklyというitemを作ってそこに書き込む）
+保存方法や，editの閉じ方はemacsと同じ操作方法です．
+\begin{lstlisting}[style=customRuby,basicstyle={\scriptsize\ttfamily}]
+nasu% my_todo.feature
+# language: ja
+
+機能: todoの更新を行う
+自分のするべきことを書き込むためにtodoを更新する
+
+シナリオ: コマンドを入力してtodoを更新していく
+          前提 todoを編集したい
+          もし "my_todo --edit"と入力する
+          ならば editが開かれる
+          かつ 自分のtodoを書き込む
+
+\end{lstlisting}

data/{my_help_nasu → docs/nasu}/latex_dir/head.tex

@@ -1,5 +1,5 @@
 \title{卒業論文\\
-\vspace{4cm} ユーザメモソフトmy\_helpの開発}
+\vspace{4cm} ユーザメモソフトmy\_helpのビヘイビアテスト開発}
 \author{ 関西学院大学　理工学部　情報科学科\\\\2535 那須比呂貴}
 \date{\vspace{3cm} 2017年  3月\\
 \vspace{3cm} 指導教員　　西谷　滋人　教授}

data/{my_help_nasu → docs/nasu}/latex_dir/introduction.aux

@@ -1,7 +1,7 @@
 \relax 
-\@writefile{toc}{\contentsline {section}{\numberline {1}序論}{5}}
+\@writefile{toc}{\contentsline {section}{\numberline {1}序論}{4}}
 \@setckpt{introduction}{
-\setcounter{page}{6}
+\setcounter{page}{5}
 \setcounter{equation}{0}
 \setcounter{enumi}{0}
 \setcounter{enumii}{0}
@@ -17,6 +17,6 @@
 \setcounter{subparagraph}{0}
 \setcounter{figure}{0}
 \setcounter{table}{0}
-\setcounter{lstnumber}{1}
 \setcounter{lstlisting}{0}
+\setcounter{lstnumber}{1}
 }

data/{my_help_nasu → docs/nasu}/latex_dir/introduction.tex

@@ -1,23 +1,22 @@
 \section{序論}
-プログラム開発では，統合開発環境がいくつも用意されているが，多くの現場では，terminal上での開発が一般的である．
-ところが，プログラミング初心者はterminal上でのcharacter user interface(CUI)を苦手としている．
-プログラミングのレベルが上がるに従って，
-shell commandやfile directory操作, process制御にCUIを使うことが常識となる．
+プログラム開発では，統合開発環境がいくつも用意されているが，多くの現場では，terminal上での開発が一般的です．
+ところが，プログラミング初心者はterminal上でのcharacter user interface(CUI)を苦手としています．
+プログラミングのレベルが上がるに従って，shell commandやfile directory操作, process制御にCUIを使うことが常識です．
 
-この不可欠なCUIスキルの習得を助けるソフトとして，ユーザメモソフトmy\_helpがruby gemsに置かれている．
-このcommand line interface(CLI)で動作するソフトは，helpをterminal上で簡単に提示するものである．
-また，初心者が自ら編集することによって，すぐに参照できるメモとしての機能を提供している．
+この不可欠なCUIスキルの習得を助けるソフトとして，ユーザメモソフトmy\_helpがruby gemsに置かれています．
+このcommand line interface(CLI)で動作するソフトは，helpをterminal上で簡単に提示するものです．
+また，初心者が自ら編集することによって，すぐに参照できるメモとしての機能を提供しています．
 これによって，terminal上でちょっとした調べ物ができるため，作業や思考が中断することなく
-プログラム開発に集中できることが期待でき，初心者のスキル習得が加速することが期待できる．
+プログラム開発に集中できること，さらに初心者のスキル習得が加速することが期待できます．
 
-しかし，Ruby gemsとして提供されているこのソフトは，動作はするがテストが用意されていない．
-慣れた開発者は，テストを見ることで仕様を理解するのが常識である．
-今後ソフトを進化させるために共同開発を進めていくには，仕様や動作の標準となるテスト記述が不可欠となる．
+しかし，Ruby gemsとして提供されているこのソフトは，動作はしますがテストが用意されていません．
+熟練した開発者は，テストを見ることで仕様を理解するのが常識です．
+今後ソフトを進化させるために共同開発を進めていくには，仕様や動作の標準となるテスト記述が不可欠となります．
 
-そこで，本研究では，ユーザメモソフトであるmy\_helpのテストを開発することを目的とする．
-本研究では、テスト駆動開発の中でも，ソフトの振る舞いを記述する
-Behavior Driven Development(BDD)に基づいてテストを記述していく．
+そこで，本研究では，ユーザメモソフトであるmy\_helpのテストを開発することを目的とします．
+本研究では、テスト駆動開発の中でも，ソフトの振る舞いを記述します．
+ビヘイビア駆動開発(Behavior Driven Development:BDD)に基づいてテストを記述していきます．
 Rubyにおいて、BDD環境を提供する標準的なフレームワークであるCucumberとRSpecを用いて，
-my\_helpがどのような振る舞いをするのかを記述する．
-Cucumberは自然言語で振る舞いを記述することができるため，ユーザにとって，わかりやすく振る舞いを確認することができる．
+my\_helpがどのような振る舞いをするのかを記述します．
+Cucumberは自然言語で振る舞いを記述することができるため，開発者やユーザにとって，わかりやすく振る舞いを確認することができます．
 

data/{my_help_nasu/latex_dir/consideration.aux → docs/nasu/latex_dir/method.aux}

@@ -1,22 +1,21 @@
 \relax 
-\@writefile{toc}{\contentsline {section}{\numberline {4}考察}{27}}
-\@setckpt{consideration}{
-\setcounter{page}{28}
+\@setckpt{method}{
+\setcounter{page}{7}
 \setcounter{equation}{0}
-\setcounter{enumi}{5}
+\setcounter{enumi}{0}
 \setcounter{enumii}{0}
 \setcounter{enumiii}{0}
 \setcounter{enumiv}{0}
 \setcounter{footnote}{0}
 \setcounter{mpfootnote}{0}
 \setcounter{part}{0}
-\setcounter{section}{4}
+\setcounter{section}{2}
 \setcounter{subsection}{0}
 \setcounter{subsubsection}{0}
 \setcounter{paragraph}{0}
 \setcounter{subparagraph}{0}
-\setcounter{figure}{2}
-\setcounter{table}{1}
-\setcounter{lstnumber}{17}
+\setcounter{figure}{0}
+\setcounter{table}{0}
 \setcounter{lstlisting}{0}
+\setcounter{lstnumber}{1}
 }

data/docs/nasu/latex_dir/method.tex

@@ -0,0 +1,6 @@
+ここでは、本研究で使用するcucumberの特徴について詳述する．
+cucumberはビヘイビア駆動開発(bdd)を実現するフレームワークである．
+まずはbddの現れた背景や現状を示した後、Cucumberの記述の具体例を示して，
+その特徴を詳述する．
+さらに，本研究の対象となるmy\_helpの振る舞いを使用法とともに示す．
+

data/{my_help_nasu → docs/nasu}/latex_dir/method_bdd.aux

@@ -1,11 +1,14 @@
 \relax 
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}RSpecとBDDについて}{7}}
-\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces RSpecとCucumberのRed-Green-Refactoringサイクル間の関係．}}{8}}
-\newlabel{default}{{1}{8}}
-\@writefile{lof}{\contentsline {figure}{\numberline {2}{\ignorespaces RSpecとCucumberの手順．}}{8}}
-\newlabel{default}{{2}{8}}
+\@writefile{toc}{\contentsline {section}{\numberline {2}先行研究，方法}{5}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}RSpecとBDDについて}{5}}
+\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces RSpecとCucumberのRed-Green-Refactoringサイクル間の関係．}}{6}}
+\newlabel{fig:001}{{1}{6}}
+\newlabel{default}{{1}{6}}
+\@writefile{lof}{\contentsline {figure}{\numberline {2}{\ignorespaces RSpecとCucumberの手順．}}{7}}
+\newlabel{fig:002}{{2}{7}}
+\newlabel{default}{{2}{7}}
 \@setckpt{method_bdd}{
-\setcounter{page}{10}
+\setcounter{page}{8}
 \setcounter{equation}{0}
 \setcounter{enumi}{0}
 \setcounter{enumii}{0}
@@ -21,6 +24,6 @@
 \setcounter{subparagraph}{0}
 \setcounter{figure}{2}
 \setcounter{table}{0}
-\setcounter{lstnumber}{1}
 \setcounter{lstlisting}{0}
+\setcounter{lstnumber}{1}
 }

data/{my_help_nasu → docs/nasu}/latex_dir/method_bdd.tex

@@ -1,14 +1,22 @@
 
+\section{先行研究，方法}
+ここでは、本研究で使用するCucumberの特徴について詳述します．
+Cucumberはビヘイビア駆動開発(BDD)を実現するフレームワークです．
+まずはbddの現れた背景や現状を示した後、Cucumberの記述の具体例を示して，
+その特徴を詳述します．
+さらに，本研究の対象となるmy\_helpの振る舞いを使用法とともに示します．
+
 \subsection{RSpecとBDDについて}
 ビヘイビア駆動開発(Behaviour-Driven Development : BDD)は，テスト駆動開発(Test-Driven Development : TDD)の工程への理解を深め，それをうまく説明しようとして始まりました．TDDの持つ単語のイメージが構造のテストを中心とするべしというのに対して，BDDはソフトの振る舞いに中心をおきなさいという意図があります．この違いが，初めに考えるべきテストの性質を変化させ，構造ではなく振る舞いを中心にテストを構築するという意識をもたせてくれます．
 
 さらに，ソフトの中で，オブジェクト同士がコミュニケーションをとるように，実世界において開発チームやテストチーム，あるいはドキュメントチーム間のコミュニケーションの取り方をシステムで提供しようというのがBDDのフレームワークです．CucumberとRSpecはこれを実現する一つのシステムとして提供されています．
 
-RSpecとCucumberの関係を図に示しました．これは，RSpec本から書き写した図です[1, pp.9]．RSpecでテストを書くと一つ一つのfunctionあるいはmethodレベルでRed, Green, Refactoringを行うべしという意図があります．一方で，もっと大きな枠組み，つまりシステムレベルでもこれらのステップは必要です．ところが，それをRSpecで書くのには無理があります．このレベルのテスト記述をしやすくするのが，Cucumberです．そこでもRed, Green, Refactoringが必要で，そこでサイクルが回ることを意図しています．
+RSpecとCucumberの関係を図\ref{fig:001}に示しました．これは，The RSpec Book[1]から書き写した図です[1, pp.9]．RSpecでテストを書くと一つ一つのfunctionあるいはmethodレベルでRed, Green, Refactoringを行うべしという意図があります．一方で，もっと大きな枠組み，つまりシステムレベルでもこれらのステップは必要です．ところが，それをRSpecで書くのには無理があります．このレベルのテスト記述をしやすくするのが，Cucumberです．そこでもRed, Green, Refactoringが必要で，そこでサイクルが回ることを意図しています．
 
 \begin{figure}[htbp]\begin{center}
-\includegraphics[width=10cm,bb= 0 0 737 453]{../figs/./my_help_nasu.001.jpg}
+\includegraphics[width=12cm,bb= 0 0 937 753]{../figs/./my_help_nasu.001.jpeg}
 \caption{RSpecとCucumberのRed-Green-Refactoringサイクル間の関係．}
+\label{fig:001}
 \label{default}\end{center}\end{figure}
 BDDの基本的な考え方は次の通りまとめられています．
 
@@ -16,13 +24,14 @@ BDDの基本的な考え方は次の通りまとめられています．
 BDDの目的は，ソフトウェアが使われる状況を説明するための言語を単純化することで，ソフトウェア開発チームのコミュニケーションを後押しすることです．つまり，あるコンテキストで(Given)，あるイベントが発生すると(When)，ある結果が期待されます(Then)．BDDにおけるGiven, When, Thenの３つの単語は，アプリケーションやオブジェクトを，それらの振る舞いに関係なく表現するために使われる単純な単語です．ビジネスアナリスト，テスト担当者，開発者は皆，それらをすぐに理解します．これらの単語はCucumberの言語に直接埋め込まれています[1, pp.3-6]．
 
 \end{quotation}
-手順を書き直すと次の通りです．
+手順を書き直すと図\ref{fig:002}の通りです．
 
 \begin{figure}[htbp]\begin{center}
-\includegraphics[width=10cm,bb= 0 0 737 453]{../figs/./my_help_nasu1.001.jpg}
+\includegraphics[width=12cm,bb= 0 0 937 753]{../figs/./my_help_nasu.002.jpeg}
 \caption{RSpecとCucumberの手順．}
+\label{fig:002}
 \label{default}\end{center}\end{figure}
-まずCucumberで一つのシナリオに焦点を当てて，その振る舞いを記述するfeatureを書きます．一つずつつぶしていくのがこつです．一つのfeatureが書けたら、次に，それぞれfeatureを実現するステップに分けて仕様を決めて行きます．これはTDDのred green refactoringの前に行う作業，「仕様をきめる」に対応しています．このプロセスが終了したら，RSpecに行きます．
+まずCucumberで一つのシナリオに焦点を当てて，その振る舞いを記述するfeatureを書きます．一つずつつぶしていくのがこつです．一つのfeatureが書けたら、次に，それぞれfeatureを実現するステップに分けて仕様を決めて行きます．これはTDDのred green refactoringの前に行う作業，「仕様を決める」に対応しています．このプロセスが終了したら，RSpecに行きます．
 RSpecでは実際にテストコードを書き，ここでもred, green, refactoringを行います．
 RSpecが成功したら，Cucumberのrefactoringを行います．
 

data/{my_help_nasu → docs/nasu}/latex_dir/method_cucumber.aux

@@ -1,13 +1,14 @@
 \relax 
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}Cucumberについて}{10}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.1}概要}{10}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.2}features}{10}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.3}Cucumber,RSpecインストール}{11}}
-\@writefile{lot}{\contentsline {table}{\numberline {1}{\ignorespaces }}{12}}
-\newlabel{default}{{1}{12}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.4}ディレクトリー構造と使用手順}{12}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}Cucumberについて}{8}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.1}概要}{8}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.2}features}{8}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.3}Cucumber,RSpecインストール}{9}}
+\@writefile{lot}{\contentsline {table}{\numberline {1}{\ignorespaces featureファイルで用意されているkeywordの日本語(ja)，英語(en)の対応表．}}{10}}
+\newlabel{table:one}{{1}{10}}
+\newlabel{default}{{1}{10}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.2.4}ディレクトリー構造と使用手順}{10}}
 \@setckpt{method_cucumber}{
-\setcounter{page}{15}
+\setcounter{page}{13}
 \setcounter{equation}{0}
 \setcounter{enumi}{2}
 \setcounter{enumii}{0}
@@ -23,6 +24,6 @@
 \setcounter{subparagraph}{0}
 \setcounter{figure}{2}
 \setcounter{table}{1}
-\setcounter{lstnumber}{17}
 \setcounter{lstlisting}{0}
+\setcounter{lstnumber}{17}
 }

data/{my_help_nasu → docs/nasu}/latex_dir/method_cucumber.tex

@@ -11,6 +11,7 @@ BDDはフルスタックのアジャイル開発技法です．BDDはATDP(Accept
 
 \subsubsection{features}
 Cucumberでは先の引用にある通り、振る舞いをシナリオとしてまず記述します．
+シナリオとは，一つひとつの振る舞いを，主にGiven(前提), Then(もし), When(ならば)に分けてfeaturesを記述します．
 次に，英語のfeaturesのひな形を示します．
 \begin{lstlisting}[style=customRuby,basicstyle={\scriptsize\ttfamily}]
 % cat ./featrues/sample_e.feature
@@ -30,19 +31,13 @@ Scenario: Description of scenario
 # language: ja
 
 機能: todoの更新を行う
-todoは更新していくものであり，新しく書いたり終わったものを消したいので
-バックアップをとって，過去のtodoを残しておく
+自分のするべきことを書き込むためにtodoを更新する
 
 シナリオ: コマンドを入力してtodoを更新していく
- 前提 todoを編集したい
- もし "my_todo --edit"と入力する
+ 前提   todoを編集したい
+ もし   "my_todo --edit"と入力する
  ならば editが開かれる
- かつ 自分のtodoを書き込む
-
-シナリオ: コマンドを入力してバックアップをとる
- 前提 todoの編集が終わった
- もし "my_todo --store [item]"と入力する
- ならば itemのバックアップを取る
+ かつ   自分のtodoを書き込む
 \end{lstlisting}
 このようにFeature, Scenario, Given, Then, Whenなどのcucumberが解釈する大文字で始まる
 keywordsに対して，それぞれ機能，シナリオ，前提，もし，ならばなどの単語があてられています．
@@ -53,10 +48,11 @@ featureファイルで用意されているkeywordは
 \begin{quote}\begin{verbatim}
 cucumber --i18n LANG
 \end{verbatim}\end{quote}
-によって表示される．LANG=ja, enに対しては下記の通りになっています．
+によって表示される．LANG=ja, enに対しては表\ref{table:one}の通りになっています．
 
 \begin{table}[htbp]\begin{center}
-\caption{}
+\caption{featureファイルで用意されているkeywordの日本語(ja)，英語(en)の対応表．}
+\label{table:one}
 \begin{tabular}{llll}
 \hline
 keyword   &ja(japanese)   &en(english)  \\ \hline
@@ -85,7 +81,7 @@ but (code)    &"しかし", "但し","ただし"   &"But"          \\
 %for inserting separate lines, use \hline, \cline{2-3} etc.
 
 \subsubsection{Cucumber,RSpecインストール}
-まずrspecをgemでinstallする．
+まずrspecをgemでinstallします．
 
 \begin{enumerate}
 \item gem install rspec --version 2.0.0
@@ -96,7 +92,8 @@ but (code)    &"しかし", "但し","ただし"   &"But"          \\
 /Users/nasubi/nasu% rspec --help
 Usage: rspec [options] [files or directories]
 \end{lstlisting}
-のような表示がされていればinstallができている．次に，cucumberをinstallする
+のような表示がされていればinstallができています．
+次に，cucumberをinstallします．
 
 \begin{enumerate}
 \item gem install cucumber --version 0.9.2
@@ -107,10 +104,10 @@ Usage: rspec [options] [files or directories]
 cucumber --help
 Usage: cucumber [options] [ [FILE|DIR|URL][:LINE[:LINE]*] ]+
 \end{lstlisting}
-のような表示がされていればinstallできている．
+のような表示がされていればinstallできています．
 
 \subsubsection{ディレクトリー構造と使用手順}
-cucumberはRubygemsの提供する基本directory構造での作業を前提としています．
+CucumberはRubygemsの提供する基本directory構造での作業を前提としています．
 その構造を表示すると次のようになります．
 \begin{quote}\begin{verbatim}
 bob% tree .
@@ -138,7 +135,7 @@ bob% tree .
 \end{verbatim}\end{quote}
 カレントディレクトリ(.)の中にfeaturesというサブディレクトリを作成します．
 そのfeaturesの中に書きたいシナリオを書いた，hogehoge.featureを作成します．
-featureの具体例は上記に示してします．
+featureの具体例は上記に示しています．
 
 次にシェルを開いて，カレントディレクトリで，
 \begin{quote}\begin{verbatim}
@@ -181,7 +178,7 @@ Cucumberはシナリオの最初のステップを読み取り,そのステッ
 
 これはfeaturesディレクトリの下にstep\_definitionsディレクトリーにあることになっています．
 このシナリオを成功させるには，Cucumberが読み込めるファイルにステップ定義を保存する必要があります[1, pp15.]．
-その内容は次の通りcucumberから自動生成されます．
+その内容は次の通りCucumberから自動生成されます．
 \begin{lstlisting}[style=customRuby,basicstyle={\scriptsize\ttfamily}]
 
 Given(/^I want to explain scenario$/) do

data/{my_help_nasu → docs/nasu}/latex_dir/method_usage.aux

@@ -1,15 +1,15 @@
 \relax 
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.3}my\_helpについて}{15}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.3.1}使用法}{15}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.3.2}my\_helpのインストール}{15}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.3.3}githubに行ってdaddygongonのmy\_helpをforkする}{15}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.3.4}my\_helpの更新}{16}}
-\@writefile{toc}{\contentsline {paragraph}{gitを用いてmy\_helpを新しくする．}{16}}
-\@writefile{toc}{\contentsline {paragraph}{次にとってきた.ymlを\nobreakspace  {}/.my\_helpにcpする．}{16}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {2.3}my\_helpについて}{13}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.3.1}my\_helpの開発動機と特徴}{13}}
+\@writefile{toc}{\contentsline {paragraph}{概要}{13}}
+\@writefile{toc}{\contentsline {paragraph}{開発動機}{13}}
+\@writefile{toc}{\contentsline {paragraph}{特徴}{13}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.3.2}my\_helpのインストール}{14}}
+\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.3.3}my\_helpの更新}{14}}
 \@setckpt{method_usage}{
-\setcounter{page}{17}
+\setcounter{page}{16}
 \setcounter{equation}{0}
-\setcounter{enumi}{2}
+\setcounter{enumi}{1}
 \setcounter{enumii}{0}
 \setcounter{enumiii}{0}
 \setcounter{enumiv}{0}
@@ -18,11 +18,11 @@
 \setcounter{part}{0}
 \setcounter{section}{2}
 \setcounter{subsection}{3}
-\setcounter{subsubsection}{4}
+\setcounter{subsubsection}{3}
 \setcounter{paragraph}{0}
 \setcounter{subparagraph}{0}
 \setcounter{figure}{2}
 \setcounter{table}{1}
-\setcounter{lstnumber}{17}
 \setcounter{lstlisting}{0}
+\setcounter{lstnumber}{17}
 }

data/{my_help_nasu → docs/nasu}/latex_dir/method_usage.tex

@@ -1,45 +1,50 @@
 
 \subsection{my\_helpについて}
-\subsubsection{使用法}
 my\_helpは本研究室の西谷が開発したものです．
+my\_helpとはユーザメモソフトであり，CUIスキルの習得を助けてくれます．
+tarminal上で簡単に提示させることができるため，プログラミングに集中することができるといった特徴があります．
+また，自分の見やすいように初心者でも簡単に編集することができ，すぐに参照できるメモとしても使うことができます．
 
-以下はmy\_helpのREADMEです[2]．
+\subsubsection{my\_helpの開発動機と特徴}
+以下はmy\_helpのREADMEからの抜粋です[2]．
 
-CUI(CLI)ヘルプのUsage出力を真似て，user独自のhelpを作成・提供するgem.
+\paragraph{概要}
+my\_help - CUI(CLI)ヘルプのUsage出力を真似て，user独自のhelpを作成・提供するgem.
 
-\begin{enumerate}
-\item 問題点
-\end{enumerate}
+\paragraph{開発動機}
 CUIやshell, 何かのプログラミング言語などを習得しようとする初心者は，
 commandや文法を覚えるのに苦労します．少しのkey(とっかかり)があると
 思い出すんですが，うろ覚えでは間違えて路頭に迷います．問題点は，
-- manは基本的に英語
-- manualでは重たい
-- いつもおなじことをwebで検索して
-- 同じとこ見ている
-- memoしても，どこへ置いたか忘れる
 
+\begin{itemize}
+\item manは基本的に英語
+\item manualでは重たい
+\item いつもおなじことをwebで検索して
+\item 同じとこ見ている
+\item memoしても，どこへ置いたか忘れる
+\end{itemize}
 などです．
 
-\begin{enumerate}
-\item 特徴
-\end{enumerate}
+\paragraph{特徴}
 これらをgem環境として提供しようというのが，このgemの目的です．
 仕様としては，
-- userが自分にあったmanを作成
-- 雛形を提供
-\begin{quote}\begin{verbatim}
- - おなじformat, looks, 操作, 階層構造
-\end{verbatim}\end{quote}
-- すぐに手が届く
-- それらを追加・修正・削除できる
 
+\begin{itemize}
+\item userが自分にあったmanを作成
+\item 雛形を提供
+\begin{itemize}
+\item おなじformat, looks, 操作, 階層構造
+\end{itemize}
+\item すぐに手が届く
+\item それらを追加・修正・削除できる
+\end{itemize}
 hikiでやろうとしていることの半分くらいはこのあたりのことなの
 かもしれません．memoソフトでは，検索が必要となりますが，my\_helpは
 key(記憶のとっかかり)を提供することが目的です．
 
 \subsubsection{my\_helpのインストール}
-\subsubsection{githubに行ってdaddygongonのmy\_helpをforkする}
+githubに行ってdaddygongonのmy\_helpをforkします．
+
 \begin{enumerate}
 \item git clone git@github.com:daddygongon/my\_help.git
 \item cd my\_help
@@ -51,7 +56,8 @@ key(記憶のとっかかり)を提供することが目的です．
 \item rake add\_yml
 \end{enumerate}
 \subsubsection{my\_helpの更新}
-\paragraph{gitを用いてmy\_helpを新しくする．}
+git hubを用いてmy\_helpを新しくします．
+
 \begin{enumerate}
 \item git remote -vをする(remoteの確認).
 \item (upstreamがなければ)git remote add upstream git@github.com:gitname/my\_help.git
@@ -60,17 +66,17 @@ key(記憶のとっかかり)を提供することが目的です．
 \item git push upstream master(ここで自分のmy\_helpをupstreamに送っとく)
 \item git pull origin master(新しいmy\_helpを取ってくる)
 \end{enumerate}
-\paragraph{次にとってきた.ymlを~/.my\_helpにcpする．}
+次にとってきた.ymlを~/.my\_helpにcpする．
+
 \begin{enumerate}
 \item cd my\_helpでmy\_helpに移動．
 \item cp hogehoge.yml ~/.my\_help
 \end{enumerate}
 それを動かすために
 (sudo)bundle exec ruby exe/my\_help -mをする.
-
-ここで過去にsudoをした人はpermissionがrootになっているので，sudoをつけないとerrorが出る．
-
+ここで過去にsudoをした人はpermissionがrootになっているので，sudoをつけないとerrorが出ます．
 (sudoで実行していたら権限がrootに移行される)
 
-新しいターミナルを開いて動くかチェックする．
-
+\begin{enumerate}
+\item 新しいターミナルを開いて動くかチェックする．
+\end{enumerate}