よく書かれていないWebサービスを文書化する最良の方法は何ですか？

Question

現時点では、私は仕事中の通知期間にいます。

私はリファクタリングの時間がない、動作していてもかなり構造化されていないWebサービスの実行（ゼロから書きました）があります。

それを継承した人が自分の名前を呪うことがないように、それを文書化する必要があります（UMLなど）。

これを達成するための最良の方法は何ですか？私は有用と思われるユースケースの図を作成しました。この混乱を次の男のためにできるだけ痛みのないものとして理解できる方法はありますか？

Answer 1

複雑な図が同期しなくなり、混乱する可能性があります。

代わりに、サービスの使い方を説明する簡単なサンプルクライアントプログラムを作成し、いくつかの共通機能を実行します。そうすれば、次のプログラマーはサービスの基礎を理解し、サービスがまだ動作しているかどうかをテストしたり、比較のためのリファレンス実装をしたり、サンプルプログラムを適応させて地面にぶつかることができます。