Software Documentation

I'm getting ready to pitch an application I made to the company I work for. They've asked me to send over the documentation for it, first. I started working on it last week and should be done by tomorrow.

I'm curious on what should be included. I've set it up kind of like a formal paper. It begins with the general idea of the application, how it should be implemented, and how it can benefit the company. The following sections of the document explain all of the features and how it plays into the business.

What else should I include? Do any of you have any experience with something like this? How does it normally flow?

Thanks

Most of people who ask for documentation never bother reading them. They do however like to "visualize" it somehow - perhaps a Visio workflow diagram will help.
Also, you may include page (or two) explaining underlying technologies (it could also be a high level diagram).
It's interesting to watch people's reaction when you mention technologies - most of them don't understand a word but will look fascinated. :)
Sometimes they may even ask you what programming language you used and why (probably because they've heard of something and would like to participate).
Regardless you definitely need to explain in a nutshell what your app does and what makes it so special or better vs some competition.
There are plenty of software documentation templates out there so try google to find what fits you best.

I'd like to add some emphasis to RBs first sentence (perhaps the governor would pardon him for his second sentence).

Add an Executive Summary or Abstract to the top. The point of that is to be SHORT! Half a page, tops, should be your target. In that summary, state what the program will do, and how it will benefit the company, stripped of all technological langauge unless you know that some phrase is essential. Most people will read ONLY the summary, so it IS your sales pitch. The rest of the material is supporting information to demonstrate that you have more than just the summary language.

Thanks a lot, guys. That's exactly what I needed :D

If the application is already made like you said, the best presentation might be a few examples (short videos or slides) of it in use.

Quote:

---

Originally Posted by baja_yu

If the application is already made like you said, the best presentation might be a few examples (short videos or slides) of it in use.

---

The way they made it sound, was they wanted to see the documentation to see if they were interested.

Would it be wise to insert slides/pictures in the documentation to help explain parts?

Yea, screenshots won't hurt but they need to be presentable and right to the point.