IT・Web制作会社のマニュアル・手順書で押さえること
環境構築の手順が人によって違う
エンジニアごとにローカル環境の作り方が違い、READMEも更新が止まっていることが多いです。新人が入るたびに先輩が隣について説明し直すことになり、同じ時間を何度も使っています。
見積り・納品のフローが口伝え
見積書のフォーマット、提案書の構成、検収までの流れがディレクターの経験に依存していて、文書として残っていないことがよくあります。担当が替わるとクライアントへの説明が微妙に変わってしまいます。
サーバー・保守の手順が属人化
ドメインやSSL証明書の更新、バックアップ、デプロイの手順が特定の担当者しか分からない状態になりやすく、休みや退職のときに作業が止まる心配があります。
コーディング規約がプロジェクトごとに違う
命名規則やディレクトリ構成が案件やデザイナーの好みで変わり、引き継いだエンジニアが毎回ルールを聞き直すことになります。新人教育のたびに同じ資料を口頭で補足しています。
マニュアル・手順書のシステムに要る機能
- 手順書をキーワードで検索できる
- Markdownでコードブロックをそのまま貼れる
- 画面キャプチャやスクリーンショットを貼れる
- チェックリスト形式で手順を一つずつ確認できる
- 担当業務(デザイン・コーディング・サーバー管理)別にカテゴリ分けできる
- 更新履歴が残り、いつ誰が直したか分かる
- 過去の版に戻せる
- 社外に出せない内容を区別して管理できる
どこを何で持つか
業界の専用ソフト・既存サービスに任せたほうがよい部分
ソースコードの変更履歴はGitやGitHubの仕組みに任せ、デザインファイルの管理はFigmaなど使い慣れたツールのままにしておくのが現実的です。手順書で扱うのは、それらのツールをどう使うかという「やり方」の部分です。
オープンソースや買い切りのシステムで持てる部分
環境構築手順、見積り・納品のフロー、保守・デプロイの手順は、自社の仕事の進め方そのものなので、自分たちで直せる道具で持つのが向いています。ソース付きのオンプレミス製品であれば、現場に合わせて改造した内容がそのまま社内の資産として積み上がります。
紙・Excelのままでよい部分
サーバーやドメインの契約情報を一覧にした台帳程度は、Excelの簡単な表のままでも支障はありません。頻繁に更新しない、手順を説明する必要がない情報はそのまま残してかまいません。
すぐ導入できるオンプレミス製品（Kurage App Store）
当社が販売しているマニュアル・手順書向けのオンプレミスの商品です。月額はかかりません。デモを触ってから判断できます。
マニュアル・手順書に使えるオープンソース
カタログ2,922件から、マニュアル・手順書に当てはまるものを実測値（規模・日本語対応・デモの有無）で並べています。ライセンスの範囲で無料で使えます。
| 名前 | できること | ライセンス | 日本語 | デモ・購入 |
|---|---|---|---|---|
| Kurage Architect | 会話から実装可能なシステム設計書を作る、ローカルLLM対応の対話型設計スタジオです。 | MIT | 日本語対話と日本語設計書に対応。 | 触れる |
| Kurage Memo | 本文の1行目がそのままタイトルになる、1ファイルPHPのメモ帳です。 | MIT | 日本語で開発・提供。 | 触れる / オンプレミス版 |
| AFFiNE | 計画、整理、創造を統合した次世代のナレッジベースです。 | MIT（一部は別ライセンス） | 日本語ファイルが一部のみ | — |
| Memos | 思いついた内容をすばやく記録し、自社で管理できるオープンソースのノート作成アプリです。 | MIT | 日本語ファイルが一部のみ | — |
| Joplin | プライバシーを重視し、複数の端末で同期して使えるノート作成アプリです。 | AGPL-3.0 | 日本語ファイルあり | — |
| SiYuan | 人間とAIエージェントが協調して作業を行う、プライバシー重視のセルフホスト型知識管理ワークスペースです。 | AGPL-3.0 | 日本語ファイルが一部のみ | — |
導入の進め方
- 各担当者が持っているREADMEやSlackのメモ、個人のノートを一度洗い出し、重複や食い違いを確認します
- 新人からよく聞かれる質問(環境構築、コーディング規約、見積りの書き方など)から優先してマニュアル化します
- 繁忙期や納期直前を避けて、まず1チーム・1業務分だけ試験的にツールへ移行します
- 閲覧・更新の権限と、誰がいつ直すかのルールを決めてから全社に展開します
- 案件が一つ終わるタイミングで手順の差分を書き加える運用にし、更新が止まらないようにします
IT・Web制作会社のマニュアル・手順書、何から手を付けるか一緒に決めます
初日のヒアリングと提案は無料です。いまのやり方（紙・Excel・使用中のサービス）を見せていただければ、残すもの・置き換えるものを仕分けしてお返しします。
無料で相談する OSSカスタマイズ（110,000円〜） 動くデモを先に見るよくあるご質問
クラウドのメモツールではなく、わざわざオンプレミスの製品を使う理由は何ですか
サーバー構築手順やクライアントの機密情報を含む内容を、社外のサーバーに預けたくないという事情が多いです。ソース付きの製品であれば、自社の運用に合わせて項目や表示を直した分がそのまま積み上がっていきます。
ディレクター・デザイナー・エンジニアで手順書を分けた方がよいですか
役割ごとにカテゴリは分けつつ、受注から納品までの全体の流れは一つの手順書でつなげておくと、新人が自分の作業の前後を把握しやすくなります。
手順書を作っても誰も更新しなくなりそうなのですが
案件が一つ終わったタイミングで、気づいた差分だけ書き加えるルールにすると負担が小さく続きやすいです。Markdownで書けるツールなら、コードや画像を貼る手間も少なく済みます。
IT・Web制作会社の他の業務
他の業種でマニュアル・手順書を見る: 介護事業所 保育園・幼稚園 美容室・サロン 飲食店 宿泊・ホテル・旅館 建設・工務店 クリニック・医療 不動産会社
記載のサービス名・製品名は各社の商標または登録商標です。本ページは当社が独自にまとめた情報であり、各提供元が監修するものではありません。
