Software specification / design documentation

[MarkLuvsCS]

I know this may seem out of place, but I figured this would be the most appropriate spot to ask you about this.

Does anyone happen to have any professionally created software specifications/design documentation? I've been working with my professor on a mobile android app, and he wants me to create a specs/design doc for the app. I've talked with him over the things to include but I'm having a hard time thinking of the best way to organize it all. I was hoping someone here has had to do this themselves or has helped someone before. If you could share any examples, I would be incredibly thankful. I've tried googling things and most of what I see discusses startups, and general items to include, but I haven't seen any good examples myself.

Thanks!

 

[purbeast0]

i don't have one that i can show, but use the good old saying of "KISS" (keep it simple stupid)

i've worked at places where we had RETARDED design documents. i'm talking like 200+ pages for a 2 month feature. and it would have 1 page explaining each control. like if there was a form to add an address, there would be a page on the street field, the city field, state dropdown, etc. it was complete overkill.

i have one for a side project but i can't share it. it's about 30 pages for a full featured mobile app that i've been working on with 1 other developer for about 6 months now, with about 2 left (just for scope vs. document length). it goes into the exact details of features and how it all works (with some stuff missing that we add when questions come up). it has screen shots (which started as wire frames then updated as we got real mockups from a professional) of the sections, then explanations of what is going on below it in a list format, with sub lists as necessary.

keep the design document "in english" though. don't go into technical details. if you need that, then make a functional requirements document that maps to the design doc. you want to be able to show non-technical people the design document and have them get what is going on.