How do I write a spec?

[sm1]

Hi all,

Interested in any info anyone can share. If I'm writing a spec for a web application, what are the most important things to include?

So far I can think of:

*The main functions
*Time-scales
*Some sketches of the pages to show layout/design
*Some inspiration/sites
*The level of support we require afterwards

Anything else?

 

[FireFleur]

Yes that's about right for a requirements spec.

Real trick is to read it through a few times over a few days, prioritise things, and mark unknowns or degrees of assurance.

If you can produce a critical path that is useful as well, but leave enough to make alteration.

Some, do create a few project plans, for different groups of people it can be pessimist, realist, optimist, but often it is bank manager, tech, and investor

Don't forget a design spec, I think the ideas section covers that a bit, but giving enough over can help them out a lot.

Not choosing the tech up front is very wise, find the right environment to suit the team and the problem space, so have a technical and design spec coming from the requirements spec.

 

[Cornish Steve]

I've been through this a lot in the last few years. For what it's worth, here's the advice I would pass along.

1) Don't write a spec, pass it along, and wait for the developers to come back. Instead, consider an iterative prototype approach. Ask them to build a rapid prototype, and then work with them to flesh out each part of the application. There are several reasons for doing this, not least of which is that you'll see better ways to do things as you play with the prototype. (In effect, the prototype becomes your spec.)

2) Be wary of a fixed price contract. While it limits your exposure, you'll find it can also be quite restrictive. Maybe bite off chunks of the work and ask for a fixed price, but leave yourself the flexibility to change direction.

3) Make sure you have good and frequent communication with your developers. It's easy to cross your wires and miscommunicate, so put all major decisions in writing. In my case, the developers are almost always online with Skype. We trade IMs a few times each week and have a Skype call once a week.

4) The really difficult balance is between micromanaging and delegating too much. I tend to go into detail about what I want, but I make it clear to the developers that, if they think of something better, to use their initiative.

Hope this helps.

 

[Chris Ashdown]

I would do it a different way, as a new owner of a web site you will probably have very limited knowledge of what you actually require

If you contact a few designers who have a home page that looks good and profesional, then ask them for the names of a few of their sites they have done in your chosen field

Spend a few days looking in detail at these sites, maybe even buying a small item to run right through the whole system( whats a few quid ver knowledge)

After a week or so you will have a good idea of what you want and can describe it more fully to the designer

Things to consider
Who owns the design
who is arranging the server and who will maintain it
who will modify the site if required and under what terms and time restraints
Is the designer just producing the design and then its all down to you or is it a longer term relationship
How are you paying, stage payments or what
who is inputting the products
Is the designer incorporating good SEO within the site

I am sure others will have a much bigger list

PS Make sure you have a full written contract with time restraints and full finance etc

Good Luck

 

[AndyWright]

You didn't say what type of app it is so it's hard give you a more specific answer so:

Read some of these books

Go to stackoverflow [dot] com and search for "Books for web application development?"

And subscribe to this feed

discuss [dot] joelonsoftware [dot] com/?biz

Good luck!

 

[creospace]

Stefan,

If you email me I'll provide you with a few docs to help you through this process. There's also a couple of posts on our blog about this subject.

Gary

 

[SydOpenk1ra]

Hi all,

Interested in any info anyone can share. If I'm writing a spec for a web application, what are the most important things to include?

So far I can think of:

*The main functions
*Time-scales
*Some sketches of the pages to show layout/design
*Some inspiration/sites
*The level of support we require afterwards

Anything else?

Over the years I've written a large number of specifications; I' happy to pass some on to you so you can use one as a template. Whilst I generally agree with an iterative (agile) approach this can be more expensive if using external contractors and it can also take longer. My advice, for what it's worth is develop a basic specification and deliver that to the developers and make sure you see mock-ups of templates, site graphics and the overall flow of the site. Most importantly you ned to mke sure that you deliver the content to the developers in good time, many web projects stumble because not all content is ready when the developer needs it.

Finally, mke sure the content is short, sharp and concise and has the necessary keywords that clearly identify your business to Seach Engines.

PM me if you want a template

 

[sm1]

Thanks all for the info, really appreciated. I will take all into consideration and make a balance between a written spec and wireframe sketches alongside prototypes!

To those that have offered templates, thanks a lot - I will send either PM's or emails

Cheers!

 

[awebapart.com]

If I'm writing a spec for a web application, what are the most important things to include?

Before deciding what to include in your website brief/spec, you have to decide what type of website brief/spec you are writing. Are you specifying your business requirements/problem or are you specifying your technical solution.

Have a look at this website brief post for more information.

 

[sm1]

Thanks Paul - it is a solution we'll be creating to solve others problems.

Cheers

 

[awebapart.com]

Even if you want a website which solves other's problems, you don't need to spec out the technical solution for it, you could still just spec out the business requirements, the types of problems you want to solve, and let your web supplier, the solution provider, come back with the technical solution.

 

[sm1]

Thanks Paul - that's hopefully the plan

P.s. Sorry for being so vague, just the idea isn't public yet