How to write a 'system spec' for an app based on a business spec.

Question

1.00/5 (2 votes)

See more:

I suppose what I'm actually asking for is at best a template, then some suggestions of what areas I must specify.

I have a business spec in terms of user stories together with additional validation rules etc. per story.

I think my spec, which should be divided into front and back-end, for two teams of developers, will be quite large on the basic makeup of the app - how it should be implemented (ASP.NET MVC is a requirement, as that is our standard), and thorough descriptions of the horizontal services. It will then have small appendages of detail for each use case. Am I on the correct track here?

What I have tried:

I'm slapping together a very, very rough prototype to get the shape and outline of the application, so I can get a handle on what angles to document the requirements from.

Posted 17-May-17 23:52pm

Brady Kelly

Updated 18-May-17 1:52am

Add a Solution

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

CHill60 · Accepted Answer · 2017-05-18T01:52:00

Solution 1

Not really something that can be answered in a "quick" answers forum!

You've mentioned "user stories" so I'm guessing it's an Agile environment - have a look at this An Agile Functional Specification - its-all-design.com[^]

There's some more formal stuff on this site ... or this specific page: Requirements Specifications on Agile Projects > Business Analyst Community & Resources | Modern Analyst[^]

Posted 18-May-17 1:52am

CHill60

Comments

Brady Kelly 18-May-17 10:15am

That's a good start for me, thanks. That's basically what I am looking for with this question, not a great exegesis on how to write a spec.

CHill60 18-May-17 10:21am

I used to have a half-decent site I used to use when I was heading down the BA route myself - blowed if I can find it now though(didn't copy my favourites off my old work PC :(). If I do find it I'll check it out and come back here with a link. Don't hold your breath though!

Brady Kelly 22-May-17 4:10am

I've asked it in Design and Architecture if you have any answers not suitable for the "quick" section.

CHill60 22-May-17 4:28am

Good move. Got distracted with the old-favourites search with a job offer!

Brady Kelly 22-May-17 4:59am

Ha, well done. This is also for a new job, started beginning May. This spec, due on Friday, is supposed to be my swansong intro as a capable analyst developer, not just a maintenance coder.

CHill60 22-May-17 5:13am

Break a leg!