-1

私はRuby on Rails開発者です。私のプロジェクトではAPI呼び出しを書く。 AngularjsはこのAPIを使用してウェブページにデータを表示します。ソフトウェアデザイン仕様(SDS)ドキュメントに含める内容

私はコーディングで良い思いが、これは私が私のSDS文書にlncludeするのか知らない..私は、SDSの文書を作成されます初めてです...

私は、SDSについて、インターネット上の検索を持っており、その上に記事を見つけましたが、その多くは非常に高いレベルの文書を理解することが困難でした。

私のSDSドキュメントに書き込むべき内容私のレールコードはすべてAPI呼び出しに関するものです...?可能であればPlaseは...

おかげ

答えて

1

をサンプル文書を共有するあなたは、少なくともあなたが言うように、コードがシンプルであったとしても、あなたのSDSにおけるいくつかの基本的な説明を含める必要があります。

目的、範囲、使用されるパターン(存在する場合)、データベースの詳細は、このドキュメントに必要な基本セクションです。シーケンス図はあまりにも傷つくことはありません、実際のプロセスとフローを説明するのに最適です

+0

ありがとうございます。 –