Take the 2-minute tour ×
Programmers Stack Exchange is a question and answer site for professional programmers interested in conceptual questions about software development. It's 100% free, no registration required.

You are joining the development team of an existing Android app and are handed a technical document about it.

What information would you like it to have?

share|improve this question

migrated from stackoverflow.com Feb 18 '11 at 0:54

This question came from our site for professional and enthusiast programmers.

add comment

1 Answer

Probably not the answer you are looking for, but I don't want to have to read a technical document to understand an application.

In my opinion, the most important piece of documentation for a project is the unit tests! Whenever I come across some code I don't understand the importance of, I check the test cases. Clear and comprehensive tests can speak volumes about what the code is used for, along with all the other great benefits.

One problem with technical documents, is that they become obsolete very quickly. As features get added, and source code is refactored, maintaining documentation becomes a big hassle.

Technical documents should be geared towards your clients, users, or business partners, not your developers.

share|improve this answer
    
No, it's a perfectly valid answer. I currently don't create a technical document of my Android apps for this very reason. However, I wondered if there was some information worth including in a separate document. –  hgpc Feb 17 '11 at 17:24
add comment

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.