web-dev-qa-db-ja.com

Androidアプリの技術ドキュメント

あなたは既存のAndroidアプリの開発チームに参加し、それに関する技術文書を渡されました。

どんな情報が欲しいですか?

4
hpique

おそらくあなたが探している答えではありませんが、アプリケーションを理解するために技術文書を読む必要はありません。

私の意見では、プロジェクトの最も重要なドキュメントはユニットテストです!重要性がわからないコードに遭遇したときはいつでも、テストケースをチェックします。明確で包括的なテストは、コードが何に使用されているか、およびその他のすべての優れた利点について多くを語ることができます。

技術文書の1つの問題は、非常に早く陳腐化することです。機能が追加され、ソースコードがリファクタリングされると、ドキュメントの保守が非常に面倒になります。

技術文書は、開発者ではなく、クライアント、ユーザー、またはビジネスパートナーを対象とする必要があります。

3
dbyrne