有用なソフトウェア資産でありながら、ドキュメントが作られていないため、品質保証や保守が難しい場合や、ノウハウが特定の個人に依存しているケースがよく見られます。弊社では、このようなソフトウェアのソースコードから詳細設計書や機能仕様書を再構築するリバースエンジニアリングのサービスを提供しています。お客様のソフトウェア資産に埋もれた仕様や知識、ノウハウを明確にし、ソフトウェア資産の品質と保守性を向上させることができます。
ドキュメントが存在しない。最新化されていない。
ドキュメントの整合性がとれていない。トレーサビリティがとれていない。
ノウハウが属人化されている。
ドキュメントの品質が悪い。
各規格に基づいたドキュメント設計がされていない。
関数やクラスの詳細設計だけでなく、機能仕様やアーキテクチャ設計までをリバースエンジニアリングいたします。
他社のサービスでは、ツールを使用してソースコードから関数やクラスの詳細設計を自動生成するものをドキュメント再構築サービスとして提供している場合もあります。もちろん、弊社でもこのようなサービスを提供できますが、これらの情報は基本的には「ソースコードを読めば理解できる」情報であり、それほど付加価値が高いとは言えません。 弊社では、ソースコードから抽出した詳細設計を基に、ソフトウェアが開発された際の設計意図を解釈し、より抽象度の高い機能仕様やアーキテクチャ設計へのリバースエンジニアリングを行います。これにより、ソースコードに埋もれていた付加価値の高いノウハウが明文化されます。また、弊社から提供された情報を元に、お客様はソースコードの意図を理解しやすくなり、保守作業をスムーズに継続できるようになります。 |
リファクタリングとテストを同時に実施し、ドキュメントの精度とソフトウェア資産の品質を向上させます。
これまで弊社で取り扱わせて頂いた事例では、ソフトウェアの機能追加や品質向上に迫られてソースコードを調べたものの、ドキュメントがないためソースコードを読み解くことが難しいと感じて弊社にご相談頂くことが多いです。この場合には、弊社では、単にソースコード分析とドキュメント再構築を行うのではなく、既に長年の実績と好評を頂いているリファクタリングとテストのサービスを同時に行うことを提案させて頂いております。 リファクタリングとテストは、ソフトウェアの品質向上に直接寄与するだけでなく、機能とソースコードの理解に役立つ強力な手法でもあります。これらを同時に実施することで、高い精度のドキュメントを提供し、ソフトウェア資産の品質を向上させることができます。 |
技術文書としての品質と保守性にもこだわります。
文書の構成については、アウトラインの段階からお客様との議論を重ね、成果物が読みやすく、技術用語の定義(用語集)などが適切に盛り込まれ、お客様の期待に合致するよう細心の注意を払って作業いたします。また、文書を見直す際に柔軟に変更できるように、文章や図表の管理方法などにも工夫を凝らしています。 再構築されたドキュメントは、ソースコードが更新されるたびに随時更新・反映されなければ、その有用性を保つことができません。技術文書とソースコードの連動を維持するための運用方法や、トレーサビリティを確保する方法など、品質規格に合致する提案を行い、お客様の品質要件や開発体制に合わせて、活きたドキュメントとして活用頂くためのご提案をさせて頂きます。 |
ドキュメント再構築が完了した後も、開発のサポートを提供することが可能です。
これまで弊社で取り扱わせて頂いた事例では、ドキュメント再構築後にも新しい機能の追加や修正などの要望が多く寄せられています。弊社は、ドキュメント再構築によって蓄積された専門的なノウハウを活かし、高度な開発プロジェクトに対しても効率的で高品質なサポートを提供いたします。お客様のニーズに合わせて柔軟に対応し、ソフトウェア資産の継続的な品質向上と保守性確保に貢献いたします。 |
事例1
対象: 研究用に作成・蓄積されてきたソフトウェア資産(規模20万行程度)
内容: 仕様書と内部設計書の作成、及び、テスト文書の整備およびテスト実行、新規機能開発
事例2
対象: 制御機器の設定ソフト(規模80万行程度)
内容: 仕様書と内部設計書の作成、及び、新しいアーキテクチャに基づくソフトウェアの作り直し
(新ソフトは既存の制御機器資産と100%の互換性の担保を前提)
まずはお気軽にお問い合わせください。
まず、プロジェクトの概要や背景についてお伺いいたします。 また、ソースコードの規模や全体の構造、現行のドキュメントの状況などについてもヒアリングさせていただきます。 これらの情報収集を通じて、後のディスカッションを円滑に進めることができます。
複数回のディスカッションを通じて、プロジェクトの進行方法についてご提案させていただきます。特に、ソースコードの規模が大きい場合には、ソースコードを提供いただき、弊社のエンジニアによる初期解析と静的解析ツールの活用を通じて、具体的なお見積りやプロジェクト計画を策定します。
ドキュメント再構築を実施します。また、ドキュメント再構築に留まらず、品質改善のためのテスト実施など、お客様の要望に合わせて様々なサポートを提供いたします。