kintoneアプリの設計書の作り方

2026年11月5日

kintoneのアプリは画面を見ながら作れる反面、設計の資料が残らないまま使われ続けることがよくあります。

このページでは、設計書に載せる項目と、作り方を3通り説明します。

設計書が必要になる場面

サイボウズの「kintoneガバナンスガイドライン」でも、重要なアプリは設計の資料を作っておくことがすすめられています。

アプリの設定は、いくつかの画面に分かれています。
設計書には、次の項目を載せておくと、あとから読んだ人がアプリの動きを追えます。

項目	書いておく内容	設定がある場所
概要	アプリ名、アプリID、目的、管理している人、最後に確認した日	アプリの設定の「設定」タブ
フィールド	フィールド名、フィールドコード、種類、必須かどうか、初期値、選択肢、計算式、ルックアップの参照先	「フォーム」タブ
一覧	一覧ごとの絞り込み条件、並び順、表示するフィールド	「一覧」タブ
プロセス管理	ステータス、作業者、アクションと実行できる条件	「設定」タブの「プロセス管理」
通知	アプリの条件通知、レコードの条件通知、リマインダーの条件通知	「設定」タブの「通知」
アクセス権	アプリ・レコード・フィールドのアクセス権と、行の順番	「設定」タブの「アクセス権」
プラグイン	追加しているプラグイン	「設定」タブの「プラグイン」
カスタマイズ	読み込んでいるJavaScript・CSSのファイル名と、その目的	「設定」タブの「JavaScript / CSSでカスタマイズ」

道具を使わずに作るなら、ExcelやGoogleスプレッドシートに、項目ごとのシートを作って書き写します。
書き写すときは、次の点に気をつけると、あとで役に立つ資料になります。

アプリをテンプレートとしてファイルに書き出す機能もありますが、別の環境でアプリを作り直すためのファイルです。
人が読む資料としては使えません。

アプリの数が多い場合や、定期的に作り直したい場合は、kintoneのREST APIで設定を取得し、表に整える方法があります。
主に使うのは次のAPIで、どれも読み取りだけのものです。

フィールド・配置	`/k/v1/app/form/fields.json`・`/k/v1/app/form/layout.json`
一覧	`/k/v1/app/views.json`
プロセス管理	`/k/v1/app/status.json`
通知	`/k/v1/app/notifications/general.json`・`perRecord.json`・`reminder.json`
アクセス権	`/k/v1/app/acl.json`・`/k/v1/record/acl.json`・`/k/v1/field/acl.json`
プラグイン	`/k/v1/app/plugins.json`
カスタマイズ	`/k/v1/app/customize.json`

アクセス権や通知の設定を取得するには、そのアプリの管理権限が必要です。
取得したJSONをExcelの表に整える部分は、自分でプログラムを書くことになります。

台帳屋の設計書ジェネレーター（無料）は、方法2のAPIを使って、アプリの設定をExcelの設計書にまとめるプラグインです。
概要・フィールド・一覧・プロセス管理・通知・アクセス権・プラグイン・カスタマイズの8シートを、ボタン1つで作ります。

JavaScriptやCSSによるカスタマイズは、読み込んでいるファイルの名前とURLを載せます。
ファイルの中で何をしているかは、設計書に手で書き足してください。

すべてのアプリをまとめて点検し、前回の点検から変わったフィールド・権限・プラグイン・カスタマイズを一覧にするなら、有料版の棚卸し・変更監視パックが使えます（30日間の無料試用があります）。