RedMica(Redmine互換のオープンソースウェア)のユーザーズガイドを作りました


石原です。2月にRedMica ユーザーズガイド(https://redmica-guide-ja.readthedocs.io/)を公開しました。今回原稿作成を担当したのでそのお話をしたいと思います。

『RedMica ユーザーズガイド』を公開 Redmine互換のプロジェクト管理オープンソースソフトウェアのリファレンス

RedMica ユーザーズガイドとは

RedMicaとは 、プロジェク管理ソフトウェア「Redmine」互換のオープンソースソフトウェアです。開発はファーエンドテクノロジーが行っています。半年ごとの定期的なバージョンアップにより、Redmineの次期バージョンの新機能を先行して利用できる特徴があります。

RedMica ユーザーズガイドは、RedMicaの管理者向けの機能や設定画面を解説したリファレンスです。半年ごとにバージョンアップするRedMicaの使い方をいつでも参照できるよう作成しました。プロジェクトの設定項目やRedMica全体の管理画面の設定などを一つ一つ解説しています。リファレンスはRedMicaにあわせて作成していますが、RedMicaはRedmineと互換性があるのでRedmineユーザーの方にも活用いただけます。

Sphinxを使用

今回、Redmineの書籍「入門Redmine 第4版」(弊社代表取締役前田著)の原稿をもとにユーザーズガイドの原稿を作成しました。入門Redmine 第4版は2014年に発売された書籍でRedmine 2.6に対応しています。それ以降のRedmineに追加された設定の解説を追加するのと、変更された設定の解説を更新するのが今回の作業です。画面も変わっているのでスクリーンショットを撮って差し替えました。

原稿の作成には、ドキュメント生成ツール Sphinx を使用しました。Sphinxを使用して執筆された書籍でも紹介されているとおり「入門Redmine 第4版」の原稿はSphinxで作られているためです。今回初めてSphinxを利用したので、インストールから始めました。環境準備はSphinx-Users.jpのサイトを参考にしました。

  1. Sphinxをインストール
    https://sphinx-users.jp/gettingstarted/install_unix.html#pip-macos-unix-linux
  2. プロジェクトを作ってhtmlを作成できることを確認
    https://sphinx-users.jp/gettingstarted/make_project.html

なお、ユーザーズガイドのソースコードはGitHubに公開しています。
https://github.com/redmica/redmica-guide-ja


reStructuredTextというマークアップ言語を使用して原稿を作成しています。

実際のRedMica ユーザーズガイドのページです。

サポート業務で活用

My Redmineのサポート業務で「入門Redmine」を見ながら設定を確認することがあります。Webだと本を開かなくても検索をして簡単に見つけることができるし、書籍を持っていないお客様にもURLをご案内できるのが便利です。

今月はRedMica 1.3がリリースされる予定です。新しいバージョンにも対応していけるよう更新していきます。また、管理機能以外の設定や機能についての情報も今後追加していく予定です。たくさんの人に役立つユーザーズガイドを作成していきますのでぜひご活用ください!

こちらの記事もオススメです!
社内マニュアル整備に活躍中 ドキュメント生成ツールSphinx
社内マニュアルの作成に便利なオープンソースのドキュメント生成ツール「Sphinx」を紹介しています。
スマートフォン2台持ちになりました
2台のスマホを使い分けることで、よりスマホを安全に使える安心感を得られました。
AWS Amplify のサンドボックスを試してみた
AWS Amplifyのサンドボックスを利用するとAWSアカウント無しでAmplifyの一部機能を試せます。
Webサイトのデプロイ作業をAWS Amplifyに移行しています
WebサイトへのデプロイをAmplifyに移行。設定ミスを防ぐためCloudFormationを活用しています。
TourBoxを使って動画編集処理の時間短縮に成功!
ダイヤルやボタンにキーボードショートカットを自由に定義。Premiere Proでの動画編集作業がとても楽になりました。
ファーエンドテクノロジーからのお知らせ(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」配信中
新バージョンやセキュリティ修正のリリース情報、そのほか最新情報を迅速にお届け