うちの会社の文書管理(その1) − SphinxとMercurialによる作成・版管理

岩石です。
今日は節分ですね。最近は 恵方巻きいわし などこの季節になるとTVやスーパーなどで見かけるようになりました。
私が子供の頃は、 豆まき しか知らなかったのですが、いつの間にやら土地土地の風習が全国区になり、習慣となっているのだと思います。
情報が場所に関係なくリアルタイムで流れ、取得できる今の時代、何が流行となるか本当にわかりませんね。
ちなみに、我が家でもこの時期は方角の話題が食卓で出ることがあります。

社内文書管理

今回は弊社の社内ドキュメント管理についての話を書きます。


サンプルなので、弊社の文書じゃないですよ(笑)



会社などの団体では、組織内に様々なドキュメントが存在します。 これらのドキュメントは役割や権限に応じて、組織内に配布や公開(自由に閲覧できるように)されます。

通常はこういったドキュメントの作成や公開は、オフィスソフト(Microsoft WordやLibre Office Writerなど)を使用し作成し、PDF形式などで公開をされることが多いと思います。
ドキュメントの公開は、専用の文書管理アプリケーションを使われるところや、ファイルサーバで管理されるところ、また紙での配付や掲示が前提の組織もあると思います。
弊社では、収納や閲覧の容易さなどの観点から、紙媒体の情報の保管をできるだけ避けるようにしています。

Sphinxを使用したドキュメント作成

弊社では、社内ドキュメントの作成に、以前社長の前田が当ブログで紹介したSphinxというツールを使用して作成を行っています。

Sphinxの良い点は、まずテキスト形式で記載ができること。作成に使用するツールは自分好みのものが使用できますし、他ツールでの編集も互換性が維持できます。
そして、ドキュメントを分割して作成・編集しそれらをまとめて一つのドキュメントにすることができます。 長くなりがちのドキュメントを章ごとなどでいくつかのファイルに分割して編集し、最終的に一つのドキュメントとして作成することで長いドキュメントも編集が楽になります。
作成されたドキュメントでは、標準で検索機能も提供されますし、ラベルへのリンクや引用なども連携させることができます。


弊社の就業規則

ドキュメントの改版管理

弊社ではSphinxのテキスト形式で編集する特徴を活かし、作成するドキュメントの一連のファイル群をMercurialのリポジトリで管理しています。
※リポジトリ・・・・・情報を体系立てて一元管理する場所のこと

ファイルを管理するリポジトリの形式としてはSubversionGitなどありますが、弊社では開発プログラムソースコードの管理は、原則としてMercurialで管理しており、ドキュメント類もMercurialで管理しています。

管理に使用するアプリケーションは、Kallitheaというツールで、これも以前前田がブログで紹介しています。


就業規則に関するリポジトリの管理画面

ドキュメントをリポジトリで管理するメリットとしては、

などのメリットがあります。

業務で使用するドキュメントは改版管理・最新版提供が重要です。改版の差分情報や日時が確実に明確にシステムで管理できるため、人がこの部分の管理を行わなくてすむようになりました。


前回の当方のブログの記録

改版の承認記録

Kallitheaのリポジトリを使用するメリットは他にもあり、最も重要なメリットの一つが プルリクエスト です。
改版管理が業務のドキュメントに必須であることは述べましたが、その改版を誰が承認したかが重要になる書類も多々あります。
弊社ではこの承認活動をプリリクエストという機能で行っています。


当方が行ったプルリクエストの履歴

プルリクエストとは、リポジトリにファイルの変更を申請し、承認されるとマージして取り込まれるという機能です。 通常はオープンソースソフトウェアなどのプログラムソースコードにおいて、管理権限を持たない方が、改変の提案として送るものです。権限者が良いと判断したら取り込まれ、理由があるなどして否認したら取り込まれないというものです。

弊社では承認が必要なドキュメントは、改版作業を行った後、上位職者などリポジトリの権限を持つものにプルリクエストを送り取り込む様にしています。

これにより、承認の活動自体もシステムで記録されることになります。


承認されたドキュメントは公開が必要ですが、その話はまた私の次回ブログで書こうと思います。

ファーエンドテクノロジーからのお知らせ(2021/06/09更新)
【6/18開催】Redmine 4.2 / RedMica 1.3 新機能解説セミナー
Redmineの最新バージョンRedmine 4.2 / RedMica 1.3 の新機能を紹介するセミナーを開催します。
プロジェクト管理ツール「RedMica」バージョン 1.3をリリース
今日使える明日のRedmine「RedMica」の最新バージョン1.3をリリースしました。
プロジェクト管理サービス『My Redmine』の契約件数が1000社を突破
Redmineのクラウドサービス『My Redmine』の契約件数が2021年5月に1000社を突破しました。
「FAREND NEWS」2021年第2号 発行
広報紙「FAREND NEWS」2021年第2号を発行いたしました。
Redmineの最新情報をメールでお知らせする「Redmine News」配信中
新バージョンやセキュリティ修正のリリース情報、そのほか最新情報を迅速にお届け