Computer programmer asked me to write a "complete specification" for project I need. Looking 4 examples.

Question

According to the paperwork it seems as though the programmer is telling me that something like this is "very tricky" I dont know if he is doing that so that I can be charged more or what. I am looking for examples of computer program specifications. I am not sure how detailed I have to be.
Thanks

Answer 1

Here is a good page on writing specification:



http://www.techwr-l.com/techwhirl/magazine/writing/softwarerequirementspecs.html



and you can find some templates and examples here:



http://www.processimpact.com/goodies.shtml#reqs



The programmer is correct in that complete specifications are very tricky. As much as you might think you know what you want a piece of software to do it can be quite difficult to put these requirements into writing. You will also find that once you start actually working with the program you discover things that you didn't even thing about putting in the requirements.

Answer 2

I doubt that it's so he can charge you more, since you can very easily ask someone else to develop your project for you.



As for examples, well... the sky's the limit... Different types of coding/programming use different methods... IPO Diagrams... CASE Methodology... UML... Even good old-fashioned Flowcharting are all forms of writing specifications... And each have their place, in the right setting.



There's entire courses devoted to the subject in colleges.



The need for a specification document usually stems from one of three reasons:



1.) The project is complex, which requires a lot of documentation to get it fleshed out.



2.) The programmer is concerned about 'scope creep', which means that the project seems to have a tendency to grow every time you talk about it.



3.) If you're looking for him to assign a dollar value/price to the project, then he needs to know *exactly* how big the bread box is.



You asked for some examples, though, so here's a few:



These aren't really examples, but they get across the idea that it's not as simple as it seems.

http://www.cmcrossroads.com/bradapp/docs/sdd.html

http://www.microtoolsinc.com/Howsrs.php



This is a decent example of a basic framework to work in:

http://www.processimpact.com/process_assets/srs_template.doc



And, of course, the obligatory wiki page :)



http://en.wikipedia.org/wiki/Software_Requirements_Specification



Good luck!

Answer 3

How do you know who hardened Pharaoh's heart? It might have been God himself. But if you ant to be sure, there have been several dozen translations of the Bible made in the last 60 years or so. You should consult various versions. Since you are consulting a Bible with "-eth" versions of verbs, it is most likely the King James translation, which was made just over 400 years ago. The language in that translation is in many places very beautiful, but it is 400 years old. The English language has moved on since then. Several common words in that translation have changed radically, such that they mean almost the opposite of their meaning 400 years ago, which can lead to puzzlement in some areas.

Answer 4

Sounds like what he wants are 'user specifications'. These should list what your project is to do and i/o involved. Try it from a 'black-box' approach - don't go into details of how it works...that's his job. Instead, concentrate on inputs (GUI forms, files from other apps, etc.) and outputs (reports, files to other apps, etc.) Try to at least have an general idea of what information flows into the project, what happens to it there and what flows out.

Answer 5

Basicly you have to be as detailed as possible to where any joe shmoe can understand it. I work for an engineering firm and have to assist writing specs all the time. easiest way, is to summarize all the general knowledge first, and then after that body detail out the special things. This way, for future use, you wont have to rewrite the entire thing, youll only have to do the things unique to that project in the last body of the spec. Heres an example:

(keep in mind this is for construction)



PART 1 - GENERAL

1.1SECTION INCLUDES

A.Removal of designated construction.

B.Disposal of materials.

1.2RELATED SECTIONS

A.Section 01010 Summary of Work: Owner's continued occupancy.

B.Section 01040 Coordination.

C.Section 01200 Project Meetings.

D.Section 01700 Contract Closeout: Project record documents.

1.3SUBMITTALS FOR REVIEW

A.Section 01340 Submittals: Procedures for submittals.

1.4SUBMITTALS FOR CLOSEOUT

A.Section 01700 Contract Closeout.

B.Project Record Documents: Accurately record actual locations of all electrical work that deviates from the originally used drawings.

1.5REGULATORY REQUIREMENTS

A.Conform to local code for demolition work, dust control, products requiring electrical disconnection and re connection.

PART 2 - PRODUCTS

2.1CORDS AND CAPS

A.Refer to Section 16141.

B.Straight-Blade Attachment Plug: NEMA WD 1.

PART 3 - EXECUTION

3.1INSPECTION

A.Verify that equipment is ready for electrical connection, wiring, and energization.

3.2PREPARATION

A.Review equipment submittals prior to installation and electrical rough-in. Verify location, size, and type of connections. Coordinate details of equipment connections with supplier and installer.

3.3INSTALLATION

A.Use wire and cable with insulation suitable for temperatures encountered in heat-producing equipment.



---------------------------

So i hope this helps you get the general idea.. As you can tell, its pretty complex.