数値解析ソフトを提供する企業様向けに、製品の説明書や使い方の解説ページを掲載する技術ドキュメントサイトを構築しました。決まった型に沿って書くだけで誰でも同じ見た目のページを追加でき、100〜300ページ規模まで無理なく増やし続けられる仕組みです。
■ 背景:ページが増えるほど、更新が止まってしまう
製品の説明サイトは、1ページずつ手作りしていると、ページを増やすたびにデザインやレイアウトの作業が発生し、書くことより作業に時間を取られてしまいます。
また、お客様の解析事例は、プログラムと計算結果をまとめた専用のファイル(Jupyter Notebook)で作られており、サイトに載せるたびに貼り直すと、図や数式が崩れたり、二重管理になったりする課題がありました。
■ 解決①:型に沿って書くだけで、ページが増やせる
参考にされていたサイトと同じ構成を、次の3種類の「ページの型」として用意しました。
・製品紹介ページ:製品の特長、動作環境、導入手順
・関数の説明ページ:使い方、説明、使用例、入出力の項目を決まった順番で記載
・チュートリアル・解析事例ページ:手順と計算結果のグラフ・表をまとめて掲載
型をコピーして中身を差し替えるだけで、誰が書いても同じ見た目のページになります。
■ 解決②:解析ファイルを、そのままページに載せられる
解析に使ったファイルを、そのまま解説ページに取り込める仕組みをつくりました。グラフや表だけを本文の好きな位置に差し込むこともでき、図の番号や参照リンクも自動で付きます。
元のファイルは1つのままなので、貼り直しによる崩れや二重管理が起きません。
■ 解決③:ページ追加から公開まで、4ステップで完結
① 型をコピーして書く → ② 手元のパソコンで見た目を確認 → ③ 送信 → ④ 数分後に自動で公開
公開前には、リンク切れや表示の崩れを自動でチェックします。変更の履歴はすべて残るため、間違えてもすぐに元に戻せます。
■ 工夫した点:機能を増やすのではなく、「続けられる形」に絞る
保守契約を前提にしないというお客様の方針に合わせ、「保守しなければならないものを減らすこと」を設計の目標にしました。
・常に動かし続けるサーバーを持たない構成にし、月々の運用費を数百円程度に抑えました
・お問い合わせや利用者登録は既存の企業サイトのフォームを使い、窓口の二重管理をなくしました
・サイトの構成をすべて設定ファイルとして残したため、担当者が変わっても、万一環境を失っても、同じサイトを作り直せます
・既存の企業サイトには手を入れず、配色や書体をそろえ、メニューから自然に行き来できるようにしました
■ その他の機能
・日本語に対応したサイト内検索
・ページ内の目次と、製品・カテゴリ・ページの3段階で整理したメニュー
■ 納品物
サイト一式、3種類のページの型、執筆環境の準備手順書、運用マニュアル、操作説明会(オンライン)