Python モジュールを作成した後、ドキュメントをどのように作成すればよいでしょうか?

Question

私は初心者で、これまで Python プログラムをリリースしたことがありません。
最近、先生から 2 つの小さな Python モジュールを作成するように頼まれました。1 つは pdf を txt に変換するもので、もう 1 つは変換された txt ドキュメントの類似性を計算するものです。これを作成し、サードパーティ ライブラリにパッケージ化する方法は知っていますが、サポート ドキュメントの書き方がわかりません。
ネットでも調べたのですが、コメントの内容がドキュメント（このコメントは慎重に書きました）だと言っている人もいましたが、パッケージにtxtファイルを入れて書く必要があるのか​​分かりませんさまざまなモジュールのさまざまな関数の使用法を書き留めてみるのはどうでしょうか?
皆さん、ありがとうございます。この書類の書き方が本当にわかりません...

Answer 1

スフィンクス

Answer 2

git プロジェクトの readme ファイルに似た git も使用したことがあるかと思います。readme を作成する目的は、おそらく、プロジェクトが何であるかを他の人に知らせることです。できることとその使い方に注目してください。

Answer 3

例:

模块.py

リーリー リーリー