キンコミ kintone user community

みんなの投稿

2023/05/23 14:49

kintoneの仕様書についてアイデアを募集しております。

今後、構築した本人が異動、退職したときにデータがどのように連携しているか次のシステム担当が分かるようにして欲しいと指示を受けております。

私もシステムに関しては初心者で仕様書を作成したことはありません。

メンテナンスをする方に引継ぎができるようなものを残したいのですが、皆さんどうされていますか?

3件のコメント (新着順)
むたろう
2023/05/24 10:11

アプリ単体だけではなくアプリ間のデータ連携だとかは仕様書にするの大変ですよね・・自分も悩んでいる部分です。

アプリ管理者メモにこのフィールドはどういう意図で~と記載したり、プロセスやデータの繋がりなど全体の構成に関してはフローチャートを残していますが、後で自分がわかるようにしか作れていないので引継ぎに使えるかと言われれば微妙かもしれません。

ちなみに、R3さんのカスタマインを使用しているアプリではデプロイ機能で設計書を作ってくれますが(添付の画像はフィールドの構成。他にもプロセスだとか一覧とかもあります。)これも引継ぎに使えるかはわかりませんね・・


yuri
2023/05/24 11:02

むたろうさん

ご助言頂きありがとうございます。

全体はもちろんですがフィールドの構成まで残してあげられたらとても優しいですよね。
社内引継ぎ資料ですし、後のち編集し続けることを考えると、そこまで作成するか迷っております。

システムに明るくない方が多いので分かりやすいフローチャートや構成図の作成からやっていきたいと思います!

tensin川岸
営業
2023/05/24 08:48

お客さんのkintoneを構築するサポートをしている手前、仕様書とまではいかなくても簡単な資料はよく作ります。

最初はルックアップや関連レコード一覧、データ連携系プラグインやカスタマイズで繋がりのあるアプリ同士の相関図(構成図)を用意してみると、他にも何が必要となるかイメージが湧いてくるかもしれません(全体の構成図の後は各アプリ内のフォーム、プロセス設定の説明もあると分かりやすいな…等等)。


yuri
2023/05/24 10:50

tensin川岸さん

ご助言感謝いたします。

システム構築がほとんど初めてのため、相関図や構成図も色々調べつつ作成しております。
kintoneの構成図において分かりやすく作成するコツなどありますでしょうか。

ご迷惑でなければぜひご教授願いたいです。

tensin川岸
営業
2023/05/24 14:39

コツという程のものでもないのですが、
構成図はアプリを表す図形を矢印で繋ぐだけのシンプルな形となるようにしています。
図形の色と矢印の種類で違いが分かるようにする事が多いですね。
参考までに構成図のサンプル画像をアップしておきました。

最初にこの様な感じのシンプルなものを作って相手に見せ、
出てくる質問に応じて加筆したり追加資料を用意したりしてます。

あとは、諸々の設定変更履歴を記録する為のアプリを用意し、
後からいつどんな変更をしたのかを振り返る事が出来るようにもしてますね。

【追記】
ちゃんと頭の中がまとまるまでは書いたり消したりできた方が良いので、構成図はいきなりPPT等で作らず最初は消せるペン使って手書きで書くようにしてます。

yuri
2023/05/25 17:03

tensin川岸さん

ご丁寧にありがとうございます。
矢印の種類や色でデータ連携の方法を分けているのですね!

一目で分かりやすく、作りやすそうです。
挑戦してみます。
ありがとうございました!!

yuriさん

引継ぎや仕様書は悩みますね。

yuriさんは仕様書作成はじめてとのこと。
では、まずkintoneの標準機能である「アプリ管理者用メモ」を利用されてはいかがでしょうか。

https://jp.cybozu.help/k/ja/id/040558.html

ここにアプリ作成者のメモがあるだけでも、ぜんぜんちがうと思います。
ここに書ききれない内容は仕様書の保存先を記載する方法もありますね。

アプリ管理者メモについては、以前キンコミでディスカッションしたことがありますのでご参考まで。
https://kincom.cybozu.co.jp/chats/saazpuyu0rtiecir


yuri
2023/05/24 10:44

西村 志郎さん

ご助言ありがとうございます!!

「アプリ管理者用メモ」の存在は使い始めの時に認識していたものの、今の今まで思い浮かびませんでした・・・。
簡単なことでしたらここに置いておけば仕様書の紛失なども防げてとても使いやすくなりますね。

ありがとうございます!