0
votes
1answer
93 views

Documentation required for commissioned software (product) [closed]

The company I work for has commissioned a software company to produce a compliance software for several big companies. As part of our contract it is required of them to provide us with src code and ...
1
vote
1answer
13k views

Difference between functional and technical specification [duplicate]

I'm writing a specification for a project, and am struggling with separating functional specification from technical specification (see http://www.joelonsoftware.com/articles/fog0000000035.html). ...
15
votes
6answers
1k views

Can you claim that your product is fit for purpose when it uses OSS software which does not guarantee it?

I am working on a product for a client that must be valid and fit for purpose. It's built on a LAMP stack (PHP/Cake), so there's GPL, MIT, PHP, APACHE licenses: "AS IS" BASIS, WITHOUT WARRANTIES ...
0
votes
2answers
462 views

Software Requirement Specification documentation by professionals

I just wanted to know what is the significance of SRS(Software Requirement Specification) in programming? and what are the techniques used in preparation of an SRS .. also who writes the SRS.. is it ...
3
votes
2answers
1k views

Describing requirements in SRS - use cases?

I do not have the access to the IEEE standard and information on the net are contradictory. Can I capture user requirements in SRS using use cases? Or I should keep use cases separate as they are more ...
3
votes
2answers
13k views

What is the difference between technical specifications and design documents?

What are technical specifications? Are they the same as design documents. If not, what is the difference and some examples?
1
vote
2answers
309 views

Formalizing a requirements spec written in narrative English

I have a fairly technical functionality requirements spec, expressed in English prose, produced by my project manager. It is structured as a collection of UI tabs, where the requirements for each tab ...
6
votes
5answers
793 views

Is a functional spec a part of the System requirement spec?

I wonder, sources like wikipedia or templates I found shows that Functional spec is a part of System requirement documents. I always thought that SRD is just overall decsription of the system, with ...
0
votes
1answer
73 views

Is there such a thing as a specification-code framework?

I've been googling for a while and can't fathom why this doesn't exist yet. By a specification-code workflow I mean a system which links code to it's specification. For example I could be looking at ...
5
votes
3answers
850 views

How To Document an Object Oriented Design in Text

For my next project, I'm looking to document my Object Oriented design in simple text before jumping the gun to code it up. I want to do this for two reasons. I want to give proper thought to my ...
2
votes
1answer
153 views

Should I provide a language reference in addition to a formal specification for the programming language I am designing?

I am designing a programming language, and I would like to provide a complete documentation for it. So far, I have planned to write the following documents: An initial design outline, mostly as a ...
0
votes
3answers
763 views

How do I write a specification? [duplicate]

Possible Duplicate: how do I write a functional specification quickly and efficiently With so many projects changing halfway - and clients assuming much can be changed at no additional cost ...
5
votes
5answers
201 views

The value of an updated specification

I'm at the tail end of a large project (around 5 months of my time, > 60,000 lines of code) on which I was the only developer. The specification documents for the project were designed well early on, ...
8
votes
13answers
669 views

Can you write an unambiguous specification in a natural language like English?

It seems to me that you cannot possibly write a software specification in English that is completely free of ambiguities, simply due to the informal nature of natural language - and therefore that a ...
1
vote
4answers
308 views

What standards does your team use for your specification documents headers and footers?

TL;DR: What header/footer do you put on your Functional&Technical specifications to avoid people having different versions at meetings? Story: We're have a lot of documents, being changed by ...
11
votes
5answers
2k views

What grammatical tense should I write my specifications in?

We are currently writing functional and technical specifications in a two column format; summary sentence and technical detail. The details often refer to an appendix with diagrams, layout designs ...