技術文書の作成
次の担当者が使える形で書き残す
構築した人に電話しなくても自社の担当者が運用できるよう、引き継ぎ資料、運用手順書、マニュアルを整えます。
このサービスに関する実績を抜粋してご紹介します。

写真: jessica45 / Pixabay 
写真: stevepb / Pixabay
サービスを成果につなげる
「技術文書の作成」を事業の成果につなげましょう。技術的な作業を、それが支えるべき利用者、運用、意思決定に結び付けるお手伝いをします。 構築した人に電話しなくても自社の担当者が運用できるよう、引き継ぎ資料、運用手順書、マニュアルを整えます。
関連する実績を確かめる
このページの関連実績から、私たちの取り組み方をご確認ください。それぞれの成果の背景にある条件や、何を優先して何を見送ったかについてもお尋ねください。 14部門を支える共通インフラ計画 — 14 共通インフラ計画の対象となった研究部門
-
14部門を支える共通インフラ計画
研究機関の14部門に関わるインフラ全体の枠組みを設計。柔軟なモジュール、統一されたデータパイプライン、長期的な定着を支える体系的なサポート方針を備えた。
-
マニュアル付きPower BIプロジェクト8件を提供
Microsoft Power BIをNodeJS APIとPython FastAPIに連携させ、データ分析と可視化のための8件のPower BIプロジェクトを、詳しいマニュアルとともに納品した。
-
50,000語のソフトウェア文書を執筆
GitHub、Craft、ConfluenceでMarkdownを使い、50,000語の詳しいソフトウェア文書を執筆。知識の蓄積と工程の透明性を確保した。
-
APIを100%の一致でHuma v2へ移行
HTTP APIの649パス・760操作をFiberからHuma v2へ移行し、サーバーが登録するルートと公開するOpenAPI記述の100%一致を達成・維持した。
-
go‑taskの自動化ターゲット578個を作成
ネイティブ、Docker、HTTPSの開発モード、静的検査、テスト、データベース、デプロイをカバーする、go‑taskの自動化ターゲット578個を作成した。
-
268検査を持つリポジトリの検査基盤を構築
登録済みコミット検査268件、静的検査ルール277件、独自ESLintルール15件からなるリポジトリの検査基盤と、検査自体を試す146件のテストを構築し、人のレビューだけに頼らずビルドで基準を守るようにした。
-
継続的なセキュリティ検査を運用
コード検査、DAST、依存関係・脆弱性検査、SBOM生成、秘密情報検査、SHA固定のActionsと、21件の文書によるセキュリティ監査を組み合わせた継続的なセキュリティ活動を確立した。
-
読み取り専用のホストレポートロールを7個構築
事実、アクセス、git、指標、トラフィック、セキュリティ、プロバイダー資産を、稼働ホストからMarkdownにまとめる7個の読み取り専用レポートロールを構築し、実行で測定していない数値は出力しない規則を設けた。
-
認証情報漏出後に対象範囲の規則を記述
構成変更によって別会社の資産一覧、ファイアウォール許可、文章が混入したことを受け、リポジトリの対象範囲を定める規則を記述し、隔離した残存物も除外せず秘密情報検査の対象に残した。
-
22静的検査のコミットゲートを構築
HTML、CSS、JavaScript、Python、YAML、Markdown、Shell、リンク、綴り、秘密情報、組版を対象に、1行で説明できる検査22個と詳しい説明が必要な検査5個からなるコミットゲートを構築し、警告扱いや行内抑制を認めない方針にした。
-
51件の文書化した施策として開発を運営
54件の計画文書にわたる51件の施策としてサイト開発を進め、それぞれに未完了項目、測定結果、採用しなかった判断を記録。AIエージェント対応で見つかった8件中6件も、理由を記して見送った。
-
文書を独自の静的検査で管理
文書に、引き下げのみ可能なファイル別行数上限、目次要件、実在パス検査を設けた。完了扱いの9計画中6計画に未完了項目があり、コミットを制御する14タスクがどの文書にも記載されていないことを検出した。
-
PDF/UA‑1プロファイルの106項目中106項目に合格
9文書のPDF/UA‑1検証を記録し、設定済みアクセシビリティプロファイルの検査106項目中106項目に合格した一方、アーカイブ版は146規則のうち1項目で不合格だった。
-
フックと品質ゲートの不一致を発見
同じ検査を行うという文書の記述に反し、コミットフックと品質ゲートが異なる検査を行っていたことを、一覧を比較するテストで発見。手動でしか動かなかった5個は履歴書の文章を検査するものだった。
-
言語間の数値照合を構築
英語原文にある数値の欠落と、対象言語に合わない表記で失敗する言語間コンテンツ検査を構築し、指標が抜けたデンマーク語説明2件と英語式引用符を使うウクライナ語16箇所を検出した。
-
全FFI呼び出しを検証する構文解析器を作成
手書きの仮Cヘッダーで、削除済みの3関数を呼んでもコンパイル・リンクが通り実行時に落ちた問題を受け、実際の7,308行のCヘッダーを読み、全呼び出し箇所、列挙定数、ポインター所有クラスのfinal指定を検証する構文解析器を作成した。
-
利用者を責めないエラーメッセージに改訂
実際にはプロバイダーがアプリ専用パスワードを要求していたのに、サインイン拒否を利用者の入力誤りとするエラー表示を受け、文書化した文体基準に従ってメッセージを書き直し、プロバイダー名を明示するテストを加えた。
-
4リポジトリで共通の履歴基準を維持
4つのリポジトリに対し、Conventional Commits、絵文字禁止、帰属トレーラー禁止という共通の履歴基準をコミットメッセージフックで適用し、作業方法を定める48件の指示文書とともに運用した。
-
6収集処理が省略した入力を明示
6つのレポート収集処理が、未読ファイル、未導入の検査、認識できなかったjournal行など、読み取れなかった入力範囲を明示するよう変更。収集不能と正常なホストが同じページになると確認し、116件の実測サンプルから閾値を定めた。

