Android应用的技术文档

Question

您将加入现有Android应用程序的开发团队，并收到一份有关它的技术文档。

你希望它有什么信息？

Answer 1

也许不是你想要的答案，但是我不想为了理解一个应用程序而阅读一份技术文档。

在我看来，项目最重要的文档是单元测试！每当我遇到一些我不理解的代码时，我就检查测试用例。清晰和全面的测试可以说明代码的用途，以及所有其他巨大的好处。

技术文档的一个问题是它们很快就过时了。随着特性的增加，以及源代码的重构，维护文档就成了一个大麻烦。

技术文档应该面向客户、用户或业务伙伴，而不是开发人员。