文章の執筆にも課題管理をすると捗る

ソフトの開発では、最近はMantisやJIRAなどの課題管理システムを使って、課題を管理することが多いと思います。本格的な課題管理として使っていなくても、不具合管理として導入しているということも多いと思います。
この課題管理を長文の執筆にも使って見るとすごく捗ることに気がつきました。以前も、色々な方法で執筆の効率を上げようと試みました。課題管理のシステムについても試したことがありました。しかし、その頃は、自分自身が課題管理システムに慣れていなかったこともあり、いまいちな結果でした。

◆方針

今回は次のような方針で臨んでみました。

  • セクション単位でチケットを作成する
  • チケットのタイトルは「章番号, セクション名」のフォーマットとする
  • 各セクションで書こうと考えている内容は説明欄(詳細欄)に書く
  • 関連するセクションのチケットとを関連チケットのリンク機能で結ぶ
  • 書きながら調べたことや、思ったことはコメントにして記録する
  • 書きながら他のセクションの修正や追記がしたくなったら、チケットのステータスを変更して、コメントに自分自身への指示を書く
  • 書き終わったらセクションはその都度ステータスを解決にする
  • 目次は別ファイルで管理する

課題管理システムは何でも良いと思いますが、私は日頃からJIRAを使っているので、JIRAを使いました。今回、書いているのは書籍なので、その書籍のタイトルでプロジェクトを作りました。
以前は、チケットの順番が目次順としていたのですが、後から途中に追加したくなったときや、順番を変更したくなったときに、対応できなくなってしまったという経験があります。そのため、目次は別ファイルにしました。今回はExcelで管理しました。
調査結果などは、以前はWikiにしましたが、そこまで長文にならないので、今回はJIRAのコメント欄にそのまま入れました。
文章の種類によっては、関連資料用のWikiを作って、そっちに資料を置き、チケットから関連リンクを張るのが良いと思います。

◆中間結果

結果と言えるほどの期間、まだ、経過していないので、中間結果です。
変更が怖くなくなりました。変更すると、分からなくなってしまうということが多いのですが、なぜ変更したのかという記録や、どこを変えるのかということが記録として残るので、怖くなりました。
それと、関連リンクは強力でした。変更したときに、ついでに直した方が良いと思うところが、関連リンクに張られているセクションということが多いのです。また、ステータスを「解決」や「作業中」など適時変更するので、書き直そうと思ったまま、忘れているということが無くなりました。忘れていると、見直すときに気がつき、修正範囲が広くなってしまいます。
今回は書籍の執筆作業で行っていますが、仕様書を書くときや設計書を書くという作業にも、課題管理システムで書くべき内容を管理するという方法は有効だと思います。

投稿者プロフィール

林 晃
林 晃macOS/iOSアプリ/SDK/ミドルウェア開発が専門の開発者
アールケー開発代表。macOS/iOSアプリ/SDK/ミドルウェア開発が専門の開発者。ObjC/Swift/C++使い。豊富な開発実務経験を基に、教育コンテンツ開発、技術書執筆、技術指導、技術セミナー講師、企業内研修講師、行政・自治体職員研修講師も行います。

基礎から学ぶMetal


「基礎から学ぶMetal」を執筆しました。本書はMetalを使ってGPUプログラミングを行うための最初のステップを解説するMetalの解説書です。

私が初めてGPUプログラミングを行ったとき、どこから手をつけて、学んでいけば良いのか分からず呆然としました。もし、あのとき、これを教えてくれればという部分を解説しました。本書で解説している部分はMetalの基礎となる部分で、Metalを使うときに必ず触れることになる部分です。

詳細

基礎から学ぶSwiftUI


「基礎から学ぶ SwiftUI」というタイトルの本を執筆しました。

SwiftUIの入門書です。

SwiftUIのコンセプトは「ユーザーインターフェイスを作るための最短パスを提供する」「一度学べば(Appleのプラットフォームの)どこにでも適用できる」です。

SwiftUIの概要から始まって、一つ一つのテクノロジートピックに注目しながらSwiftUIとは何か?どんなことができるのか?どのようなコードを書けば良いのかなどを丸々一冊使って解説しています。

詳細

最近の著書

  1. 基礎から学ぶ SwiftUI

最近の記事