Wikiのテンプレート
Wikiでパタンを意識して文書を書くテンプレート。色々試したが、私のお気に入りは次。
- Name:XXXと名前を書く。Implementation Patternのように小さな要素も候補にできないか検討.
- What:XXXとは?の要約を書く
- Why:XXXの嬉しさを書く
- When:XXXをいつ使うか(使わないか)を書く
- How:XXXの詳細手順などハウツーを書く
- See Also:リンク元、関連リンク、外部参考ページを書く
テンプレート要素がとても覚え易い。それでいて、それぞれの要素は強力。Whenは、xUnit Patterns等の「When to Use It」のように。全部のテンプレート要素を無理して埋めなくて, NameとWhatとSee Alsoだけとかも融通が利く。変種で最後にThreadを追加して、私的な意見を書けるコメントスペースを追加するとか.Exampleのスペースがない??
参考は、次