ドキュメント作成の効率化
最近気になっていること。
- いかに効率良く開発するか。
- いかに効率良くドキュメントを作成するか。
このふたつは品質も、保守も含めての話。
欲を言えば、ソースコードに書いた仕様が体裁が整った状態でドキュメント化されること。 その前に、そのソースコードを書くための仕様はどうやって伝えるか?ということがあるので、現実的には難しそう。 なので、ソースコードを書く元となる仕様を書いて、その後、ソースコードを書きつつ、ソースコード中に仕様も書いていくというのが現実的かな?と思ってる。
書いたものは検索したいので、どっかに放り込んでおきたい。 今はGoogleDesktopなんて便利なものがあるから、自分のPC内は比較的簡単に素早く検索出来るんだけど、これだと情報の共有ということが出来なかったり、修正時に体裁を整えるのが大変だったりする。 実際、体裁を整えるのはセンスが必要だったり、ソフトウェアを使いこなせることが必要だったり、見えないところに前提がおかれているもの。
今日、技術評論社からいつもの "電脳会議" が届いた。 そこに載ってた書籍紹介に興味深いものがあった。
■LyX | LyX – 文書プロセッサ http://www.lyx.org/WebJa.Home ここがオフィシャルページらしい。 まだ使ってないからなんとも言えないが、これならテキストだから検索出来る! また読みたい本が増えてしまった。
この辺のツールを利用しての効率化についてまとめたいけど、時間なさすぎ。